[jbosscache-commits] JBoss Cache SVN: r6628 - searchable/trunk/src/main/java/org/jboss/cache/search.

Author: navssurtani Date: 2008-08-28 03:08:02 -0400 (Thu, 28 Aug 2008) New Revision: 6628 Modified: searchable/trunk/src/main/java/org/jboss/cache/search/CacheEntityId.java searchable/trunk/src/main/java/org/jboss/cache/search/CacheEntityLoader.java searchable/trunk/src/main/java/org/jboss/cache/search/CacheQuery.java searchable/trunk/src/main/java/org/jboss/cache/search/CacheQueryImpl.java searchable/trunk/src/main/java/org/jboss/cache/search/IndexSearcherCloser.java searchable/trunk/src/main/java/org/jboss/cache/search/InvalidFqnException.java searchable/trunk/src/main/java/org/jboss/cache/search/InvalidKeyException.java searchable/trunk/src/main/java/org/jboss/cache/search/LazyQueryResultIterator.java searchable/trunk/src/main/java/org/jboss/cache/search/NodeModifiedTransactionContext.java searchable/trunk/src/main/java/org/jboss/cache/search/PojoTransactionContext.java searchable/trunk/src/main/java/org/jboss/cache/search/QueryResultIterator.java searchable/trunk/src/main/java/org/jboss/cache/search/QueryResultIteratorImpl.java searchable/trunk/src/main/java/org/jboss/cache/search/SearchableCache.java searchable/trunk/src/main/java/org/jboss/cache/search/SearchableCacheConfiguration.java searchable/trunk/src/main/java/org/jboss/cache/search/SearchableCacheFactory.java searchable/trunk/src/main/java/org/jboss/cache/search/SearchableCacheImpl.java searchable/trunk/src/main/java/org/jboss/cache/search/SearchableCoreListener.java searchable/trunk/src/main/java/org/jboss/cache/search/SearchablePojoListener.java searchable/trunk/src/main/java/org/jboss/cache/search/Transformer.java Log: Cleaned up javadocs and LGPL licenese put in all classes. Modified: searchable/trunk/src/main/java/org/jboss/cache/search/CacheEntityId.java =================================================================== --- searchable/trunk/src/main/java/org/jboss/cache/search/CacheEntityId.java 2008-08-27 13:56:58 UTC (rev 6627) +++ searchable/trunk/src/main/java/org/jboss/cache/search/CacheEntityId.java 2008-08-28 07:08:02 UTC (rev 6628) @@ -1,3 +1,25 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright ${year}, Red Hat Middleware LLC, and individual contributors + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ + package org.jboss.cache.search; import org.jboss.cache.Fqn; @@ -5,6 +27,7 @@ /** * * This class is used to get fqns, keys and documentId's by calling methods on {@link org.jboss.cache.search.Transformer} + * <p/> * @author Navin Surtani (<a href="mailto:nsurtani@redhat.com">nsurtani@redhat.com</a>) */ public class CacheEntityId Modified: searchable/trunk/src/main/java/org/jboss/cache/search/CacheEntityLoader.java =================================================================== --- searchable/trunk/src/main/java/org/jboss/cache/search/CacheEntityLoader.java 2008-08-27 13:56:58 UTC (rev 6627) +++ searchable/trunk/src/main/java/org/jboss/cache/search/CacheEntityLoader.java 2008-08-28 07:08:02 UTC (rev 6628) @@ -1,3 +1,25 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright ${year}, Red Hat Middleware LLC, and individual contributors + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ + package org.jboss.cache.search; import org.jboss.cache.Cache; @@ -9,6 +31,7 @@ /** * Class that is used to load objects from a list of CacheEntityId ids. + * <p/> * @author Navin Surtani (<a href="mailto:nsurtani@redhat.com">nsurtani@redhat.com</a>) */ public class CacheEntityLoader Modified: searchable/trunk/src/main/java/org/jboss/cache/search/CacheQuery.java =================================================================== --- searchable/trunk/src/main/java/org/jboss/cache/search/CacheQuery.java 2008-08-27 13:56:58 UTC (rev 6627) +++ searchable/trunk/src/main/java/org/jboss/cache/search/CacheQuery.java 2008-08-28 07:08:02 UTC (rev 6628) @@ -1,3 +1,25 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright ${year}, Red Hat Middleware LLC, and individual contributors + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ + package org.jboss.cache.search; import org.apache.lucene.search.Sort; @@ -10,7 +32,9 @@ * A cache-query is what will be returned when the createQuery() method is run. This object can have methods such * as list, setFirstResult,setMaxResults, setFetchSize, getResultSize and setSort. * + * <p/> * @author Manik Surtani (<a href="mailto:manik@jboss.org">manik@jboss.org</a>) + * @author Navin Surtani (<a href="mailto:nsurtani@redhat.com">nsurtani@redhat.com</a>) * @see org.jboss.cache.search.SearchableCache#createQuery(org.apache.lucene.search.Query) */ public interface CacheQuery extends Iterable Modified: searchable/trunk/src/main/java/org/jboss/cache/search/CacheQueryImpl.java =================================================================== --- searchable/trunk/src/main/java/org/jboss/cache/search/CacheQueryImpl.java 2008-08-27 13:56:58 UTC (rev 6627) +++ searchable/trunk/src/main/java/org/jboss/cache/search/CacheQueryImpl.java 2008-08-28 07:08:02 UTC (rev 6628) @@ -1,3 +1,25 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright ${year}, Red Hat Middleware LLC, and individual contributors + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ + package org.jboss.cache.search; import org.apache.commons.logging.Log; Modified: searchable/trunk/src/main/java/org/jboss/cache/search/IndexSearcherCloser.java =================================================================== --- searchable/trunk/src/main/java/org/jboss/cache/search/IndexSearcherCloser.java 2008-08-27 13:56:58 UTC (rev 6627) +++ searchable/trunk/src/main/java/org/jboss/cache/search/IndexSearcherCloser.java 2008-08-28 07:08:02 UTC (rev 6628) @@ -1,3 +1,25 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright ${year}, Red Hat Middleware LLC, and individual contributors + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ + package org.jboss.cache.search; import org.hibernate.search.engine.SearchFactoryImplementor; @@ -9,9 +31,11 @@ import java.util.Set; /** + * Class with static method that is called by {@link CacheQueryImpl} and {@link org.jboss.cache.search.QueryResultIteratorImpl} + * <p /> * @author Navin Surtani (<a href="mailto:nsurtani@redhat.com">nsurtani@redhat.com</a>) */ -public class IndexSearcherCloser + class IndexSearcherCloser { static void closeSearcher(Searcher searcher, ReaderProvider readerProvider) { Modified: searchable/trunk/src/main/java/org/jboss/cache/search/InvalidFqnException.java =================================================================== --- searchable/trunk/src/main/java/org/jboss/cache/search/InvalidFqnException.java 2008-08-27 13:56:58 UTC (rev 6627) +++ searchable/trunk/src/main/java/org/jboss/cache/search/InvalidFqnException.java 2008-08-28 07:08:02 UTC (rev 6628) @@ -1,3 +1,25 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright ${year}, Red Hat Middleware LLC, and individual contributors + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ + package org.jboss.cache.search; import org.jboss.cache.CacheException; Modified: searchable/trunk/src/main/java/org/jboss/cache/search/InvalidKeyException.java =================================================================== --- searchable/trunk/src/main/java/org/jboss/cache/search/InvalidKeyException.java 2008-08-27 13:56:58 UTC (rev 6627) +++ searchable/trunk/src/main/java/org/jboss/cache/search/InvalidKeyException.java 2008-08-28 07:08:02 UTC (rev 6628) @@ -1,7 +1,31 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright ${year}, Red Hat Middleware LLC, and individual contributors + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ + package org.jboss.cache.search; /** - * @author Navin Surtani (<a href="mailto:nsurtani@redhat.com">nsurtani@redhat.com</a>) + * * Thrown when an invalid Key is passed into {@link org.jboss.cache.search.Transformer#generateId(org.jboss.cache.Fqn, String)} + * <p /> + * @author Navin Surtani (<a href="mailto:nsurtani@redhat.com">nsurtani@redhat.com</a>) */ public class InvalidKeyException extends Exception { Modified: searchable/trunk/src/main/java/org/jboss/cache/search/LazyQueryResultIterator.java =================================================================== --- searchable/trunk/src/main/java/org/jboss/cache/search/LazyQueryResultIterator.java 2008-08-27 13:56:58 UTC (rev 6627) +++ searchable/trunk/src/main/java/org/jboss/cache/search/LazyQueryResultIterator.java 2008-08-28 07:08:02 UTC (rev 6628) @@ -1,3 +1,25 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright ${year}, Red Hat Middleware LLC, and individual contributors + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ + package org.jboss.cache.search; import org.jboss.cache.search.CacheEntityLoader; @@ -10,6 +32,10 @@ import java.io.IOException; /** + * Implementation for {@link org.jboss.cache.search.QueryResultIterator}. This is what is returned when + * the {@link CacheQuery#lazyIterator()} method is called. This loads the results only when required and hence differs from + * {@link org.jboss.cache.search.QueryResultIteratorImpl} which is the other implementation of QueryResultIterator. + * * @author Navin Surtani (<a href="mailto:nsurtani@redhat.com">nsurtani@redhat.com</a>) */ public class LazyQueryResultIterator implements QueryResultIterator Modified: searchable/trunk/src/main/java/org/jboss/cache/search/NodeModifiedTransactionContext.java =================================================================== --- searchable/trunk/src/main/java/org/jboss/cache/search/NodeModifiedTransactionContext.java 2008-08-27 13:56:58 UTC (rev 6627) +++ searchable/trunk/src/main/java/org/jboss/cache/search/NodeModifiedTransactionContext.java 2008-08-28 07:08:02 UTC (rev 6628) @@ -1,3 +1,25 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright ${year}, Red Hat Middleware LLC, and individual contributors + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ + package org.jboss.cache.search; import org.hibernate.search.backend.TransactionContext; Modified: searchable/trunk/src/main/java/org/jboss/cache/search/PojoTransactionContext.java =================================================================== --- searchable/trunk/src/main/java/org/jboss/cache/search/PojoTransactionContext.java 2008-08-27 13:56:58 UTC (rev 6627) +++ searchable/trunk/src/main/java/org/jboss/cache/search/PojoTransactionContext.java 2008-08-28 07:08:02 UTC (rev 6628) @@ -1,3 +1,25 @@ +///* +// * JBoss, Home of Professional Open Source +// * Copyright ${year}, Red Hat Middleware LLC, and individual contributors +// * by the @authors tag. See the copyright.txt in the distribution for a +// * full listing of individual contributors. +// * +// * This is free software; you can redistribute it and/or modify it +// * under the terms of the GNU Lesser General Public License as +// * published by the Free Software Foundation; either version 2.1 of +// * the License, or (at your option) any later version. +// * +// * This software is distributed in the hope that it will be useful, +// * but WITHOUT ANY WARRANTY; without even the implied warranty of +// * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// * Lesser General Public License for more details. +// * +// * You should have received a copy of the GNU Lesser General Public +// * License along with this software; if not, write to the Free +// * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA +// * 02110-1301 USA, or see the FSF site: http://www.fsf.org. +// */ +// //package org.jboss.cache.search; // //import org.hibernate.search.transaction.TransactionContext; Modified: searchable/trunk/src/main/java/org/jboss/cache/search/QueryResultIterator.java =================================================================== --- searchable/trunk/src/main/java/org/jboss/cache/search/QueryResultIterator.java 2008-08-27 13:56:58 UTC (rev 6627) +++ searchable/trunk/src/main/java/org/jboss/cache/search/QueryResultIterator.java 2008-08-28 07:08:02 UTC (rev 6628) @@ -1,3 +1,25 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright ${year}, Red Hat Middleware LLC, and individual contributors + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ + package org.jboss.cache.search; import java.util.ListIterator; @@ -4,8 +26,9 @@ /** * Iterates over query results - * + * <p/> * @author Manik Surtani (<a href="mailto:manik@jboss.org">manik@jboss.org</a>) + * @author Navin Surtani (<a href="mailto:nsurtani@redhat.com">manik@jboss.org</a>) */ public interface QueryResultIterator extends ListIterator { Modified: searchable/trunk/src/main/java/org/jboss/cache/search/QueryResultIteratorImpl.java =================================================================== --- searchable/trunk/src/main/java/org/jboss/cache/search/QueryResultIteratorImpl.java 2008-08-27 13:56:58 UTC (rev 6627) +++ searchable/trunk/src/main/java/org/jboss/cache/search/QueryResultIteratorImpl.java 2008-08-28 07:08:02 UTC (rev 6628) @@ -1,3 +1,25 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright ${year}, Red Hat Middleware LLC, and individual contributors + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ + package org.jboss.cache.search; import org.jboss.cache.Cache; @@ -9,6 +31,8 @@ * This is the implementation class for the interface QueryResultIterator which extends ListIterator. It is what is * returned when the iterator() method is run on a CacheQuery instance. * + * <p/> + * * @author Navin Surtani (<a href="mailto:nsurtani@redhat.com">nsurtani@redhat.com</a>) */ public class QueryResultIteratorImpl implements QueryResultIterator Modified: searchable/trunk/src/main/java/org/jboss/cache/search/SearchableCache.java =================================================================== --- searchable/trunk/src/main/java/org/jboss/cache/search/SearchableCache.java 2008-08-27 13:56:58 UTC (rev 6627) +++ searchable/trunk/src/main/java/org/jboss/cache/search/SearchableCache.java 2008-08-28 07:08:02 UTC (rev 6628) @@ -1,3 +1,25 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright ${year}, Red Hat Middleware LLC, and individual contributors + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ + package org.jboss.cache.search; import org.apache.lucene.search.Query; @@ -4,12 +26,12 @@ import org.jboss.cache.Cache; /** - * @author Navin Surtani (<a href="mailto:nsurtani@redhat.com">nsurtani@redhat.com</a>) - * <p/> * This will be the most used interface in JBossCache searchable. It extends Cache and therefore will have * the standard get(), put() and remove() methods. The additional method is the createQuery method which people * will use to build their Hibernate Search queries from a luceneQuery - Hibernate Search users will be very familiar * with this. + * @author Navin Surtani (<a href="mailto:nsurtani@redhat.com">nsurtani@redhat.com</a>) + * <p/> */ public interface SearchableCache<K, V> extends Cache<K, V> { Modified: searchable/trunk/src/main/java/org/jboss/cache/search/SearchableCacheConfiguration.java =================================================================== --- searchable/trunk/src/main/java/org/jboss/cache/search/SearchableCacheConfiguration.java 2008-08-27 13:56:58 UTC (rev 6627) +++ searchable/trunk/src/main/java/org/jboss/cache/search/SearchableCacheConfiguration.java 2008-08-28 07:08:02 UTC (rev 6628) @@ -1,3 +1,25 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright ${year}, Red Hat Middleware LLC, and individual contributors + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ + package org.jboss.cache.search; import org.hibernate.search.cfg.SearchConfiguration; Modified: searchable/trunk/src/main/java/org/jboss/cache/search/SearchableCacheFactory.java =================================================================== --- searchable/trunk/src/main/java/org/jboss/cache/search/SearchableCacheFactory.java 2008-08-27 13:56:58 UTC (rev 6627) +++ searchable/trunk/src/main/java/org/jboss/cache/search/SearchableCacheFactory.java 2008-08-28 07:08:02 UTC (rev 6628) @@ -1,3 +1,25 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright ${year}, Red Hat Middleware LLC, and individual contributors + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ + package org.jboss.cache.search; import org.hibernate.search.impl.SearchFactoryImpl; @@ -12,6 +34,12 @@ import java.lang.reflect.Field; /** + * Factory class used to create the searchable-cache like so: - + * + * <p/> + * SearchableCache searchableCache = SearchableCacheFactory.createSearchableCache(coreCache, class[]); + * + * <p/> * @author Navin Surtani (<a href="mailto:nsurtani@redhat.com">nsurtani@redhat.com</a>) */ public class SearchableCacheFactory Modified: searchable/trunk/src/main/java/org/jboss/cache/search/SearchableCacheImpl.java =================================================================== --- searchable/trunk/src/main/java/org/jboss/cache/search/SearchableCacheImpl.java 2008-08-27 13:56:58 UTC (rev 6627) +++ searchable/trunk/src/main/java/org/jboss/cache/search/SearchableCacheImpl.java 2008-08-28 07:08:02 UTC (rev 6628) @@ -1,3 +1,25 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright ${year}, Red Hat Middleware LLC, and individual contributors + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ + package org.jboss.cache.search; import org.apache.lucene.search.Query; @@ -19,9 +41,10 @@ import java.util.Set; /** + * Implementation class for the SearchableCache interface. + * <p/> + * * @author Navin Surtani (<a href="mailto:nsurtani@redhat.com">nsurtani@redhat.com</a>) - * <p/> - * Implementation class for the SearchableCache interface. */ public class SearchableCacheImpl<K, V> implements SearchableCache<K, V> { Modified: searchable/trunk/src/main/java/org/jboss/cache/search/SearchableCoreListener.java =================================================================== --- searchable/trunk/src/main/java/org/jboss/cache/search/SearchableCoreListener.java 2008-08-27 13:56:58 UTC (rev 6627) +++ searchable/trunk/src/main/java/org/jboss/cache/search/SearchableCoreListener.java 2008-08-28 07:08:02 UTC (rev 6628) @@ -1,3 +1,25 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright ${year}, Red Hat Middleware LLC, and individual contributors + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ + package org.jboss.cache.search; import org.hibernate.search.impl.SearchFactoryImpl; @@ -16,7 +38,7 @@ /** * @author Navin Surtani (<a href="mailto:nsurtani@redhat.com">nsurtani@redhat.com</a>) * - * Listener class for changes made to the cache. This listener makes changes if it is a org.jboss.cache being used. + * Listener class for changes made to the cache. This listener makes changes if it is a {@link org.jboss.cache.Cache} being used. */ @CacheListener public class SearchableCoreListener Modified: searchable/trunk/src/main/java/org/jboss/cache/search/SearchablePojoListener.java =================================================================== --- searchable/trunk/src/main/java/org/jboss/cache/search/SearchablePojoListener.java 2008-08-27 13:56:58 UTC (rev 6627) +++ searchable/trunk/src/main/java/org/jboss/cache/search/SearchablePojoListener.java 2008-08-28 07:08:02 UTC (rev 6628) @@ -1,3 +1,25 @@ +///* +// * JBoss, Home of Professional Open Source +// * Copyright ${year}, Red Hat Middleware LLC, and individual contributors +// * by the @authors tag. See the copyright.txt in the distribution for a +// * full listing of individual contributors. +// * +// * This is free software; you can redistribute it and/or modify it +// * under the terms of the GNU Lesser General Public License as +// * published by the Free Software Foundation; either version 2.1 of +// * the License, or (at your option) any later version. +// * +// * This software is distributed in the hope that it will be useful, +// * but WITHOUT ANY WARRANTY; without even the implied warranty of +// * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// * Lesser General Public License for more details. +// * +// * You should have received a copy of the GNU Lesser General Public +// * License along with this software; if not, write to the Free +// * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA +// * 02110-1301 USA, or see the FSF site: http://www.fsf.org. +// */ +// //package org.jboss.cache.search; // //import org.hibernate.search.impl.SearchFactoryImpl; Modified: searchable/trunk/src/main/java/org/jboss/cache/search/Transformer.java =================================================================== --- searchable/trunk/src/main/java/org/jboss/cache/search/Transformer.java 2008-08-27 13:56:58 UTC (rev 6627) +++ searchable/trunk/src/main/java/org/jboss/cache/search/Transformer.java 2008-08-28 07:08:02 UTC (rev 6628) @@ -1,3 +1,25 @@ +/* + * JBoss, Home of Professional Open Source + * Copyright ${year}, Red Hat Middleware LLC, and individual contributors + * by the @authors tag. See the copyright.txt in the distribution for a + * full listing of individual contributors. + * + * This is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as + * published by the Free Software Foundation; either version 2.1 of + * the License, or (at your option) any later version. + * + * This software is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this software; if not, write to the Free + * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + * 02110-1301 USA, or see the FSF site: http://www.fsf.org. + */ + package org.jboss.cache.search; import org.jboss.cache.Fqn; @@ -3,5 +25,4 @@ /** -* @author Navin Surtani (<a href="mailto:nsurtani@redhat.com">nsurtani@redhat.com</a>) * * This class is one that does all the 'conversion' work between JBossCache and Hibernate Search. This is where @@ -10,7 +31,8 @@ * * If the Fqn is in the form /a/b/c and the key - which has to be a String - is keystring; the documentId - which is also * a String - will be "Fqn=[/a/b/c]Key=[keystring]" -* +* +* @author Navin Surtani (<a href="mailto:nsurtani@redhat.com">nsurtani@redhat.com</a>) */ public class Transformer {