com.neurosys.collection.search

Class BaseCollectionTypeDocumentsGenerator<P extends Product>

java.lang.Object

com.neurosys.collection.search.BaseCollectionTypeDocumentsGenerator<P>

All Implemented Interfaces:

com.neurosys.spider.indexer.DocumentGenerator<P,Void,com.neurosys.spider.ds.processors.ObjectDocumentRowMapperIndexer<P,Void>>

Direct Known Subclasses:

CollectionTypeDocumentsGenerator

public class BaseCollectionTypeDocumentsGenerator<P extends Product>
extends Object
implements com.neurosys.spider.indexer.DocumentGenerator<P,Void,com.neurosys.spider.ds.processors.ObjectDocumentRowMapperIndexer<P,Void>>

A given Product like a Product#ATTRIB_COLLECTION_TYPE_NAME can have multiple Products associated with it in Product.getRelatedGroups(). Using this a Document is generated for each Product that itself is responsible for multiple other Documents

Author:

Arjun Dhar TODO: Add Unit test Case

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIELDNAME_COLLECTION_NAME Maps to Product.getName()
static String	FIELDNAME_COLLECTIONTYPE_NAME Maps to value of Product#getAttribute(Product#ATTRIB_COLLECTION_TYPE_NAME)
static String	FIELDNAME_SEQUENCE_WITHIN_COLLECTION A unique sequence # Field in a Document for a Product per Collection.

Constructor Summary

Constructors

Constructor and Description
BaseCollectionTypeDocumentsGenerator()

Method Summary

Modifier and Type	Method and Description
protected String	getCollectionName(P product)
protected String	getCollectionTypeName(P product)
List<org.apache.lucene.document.Document>	getDocuments(com.neurosys.spider.ds.processors.ObjectDocumentRowMapperIndexer<P,Void> indexerRef, P collection, Void metaData, org.apache.lucene.document.Document parentDoc)
List<com.neurosys.spider.indexer.FieldGenerator<P,Void,com.neurosys.spider.ds.processors.ObjectDocumentRowMapperIndexer>>	getFieldGenerators() Provide additional ability to generate new/additional document fields based on each product found in the Collection obtained from listForProductTransformer
protected String	getId(P product)
org.apache.commons.collections.Transformer	getListForProductTransformer() Transformer that will act on the entity to generate the List of Products for a collection Note: If the transformer throws a ContinueProcessingException or a BreakChainException then the result of this generator will be null.
protected int	getSequence(P p, int naturalSeq)
void	setFieldGenerators(List<com.neurosys.spider.indexer.FieldGenerator<P,Void,com.neurosys.spider.ds.processors.ObjectDocumentRowMapperIndexer>> fieldGenerators) Provide additional ability to generate new/additional document fields based on each product found in the Collection obtained from listForProductTransformer
void	setListForProductTransformer(org.apache.commons.collections.Transformer listForProductTransformer) Transformer that will act on the entity to generate the List of Products for a collection Note: If the transformer throws a ContinueProcessingException or a BreakChainException then the result of this generator will be null.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FIELDNAME_COLLECTION_NAME

public static String FIELDNAME_COLLECTION_NAME

Maps to Product.getName()

See Also:

Product#ATTRIB_COLLECTION_TYPE_NAME

FIELDNAME_COLLECTIONTYPE_NAME

public static String FIELDNAME_COLLECTIONTYPE_NAME

Maps to value of Product#getAttribute(Product#ATTRIB_COLLECTION_TYPE_NAME)

See Also:

Product#ATTRIB_COLLECTION_TYPE_NAME

FIELDNAME_SEQUENCE_WITHIN_COLLECTION

public static String FIELDNAME_SEQUENCE_WITHIN_COLLECTION

A unique sequence # Field in a Document for a Product per Collection. We can sort using this sequence #.
The default sequence is governed by the order of the list returned by listForProductTransformer. You can override the sequencing for the Index using getSequence(Product, int)

Constructor Detail

BaseCollectionTypeDocumentsGenerator

public BaseCollectionTypeDocumentsGenerator()

Method Detail

getId

protected String getId(P product)

getCollectionName

protected String getCollectionName(P product)

getCollectionTypeName

protected String getCollectionTypeName(P product)

getSequence

protected int getSequence(P p,
                          int naturalSeq)

getDocuments

public List<org.apache.lucene.document.Document> getDocuments(com.neurosys.spider.ds.processors.ObjectDocumentRowMapperIndexer<P,Void> indexerRef,
                                                              P collection,
                                                              Void metaData,
                                                              org.apache.lucene.document.Document parentDoc)
                                                       throws Exception

Specified by:

getDocuments in interface com.neurosys.spider.indexer.DocumentGenerator<P extends Product,Void,com.neurosys.spider.ds.processors.ObjectDocumentRowMapperIndexer<P extends Product,Void>>

Throws:

Exception

getListForProductTransformer

public org.apache.commons.collections.Transformer getListForProductTransformer()

Transformer that will act on the entity to generate the List of Products for a collection
Note: If the transformer throws a ContinueProcessingException or a BreakChainException then the result of this generator will be null. For any other type of exception the exception will be thrown.

Can be null:

false

setListForProductTransformer

public void setListForProductTransformer(org.apache.commons.collections.Transformer listForProductTransformer)

Transformer that will act on the entity to generate the List of Products for a collection
Note: If the transformer throws a ContinueProcessingException or a BreakChainException then the result of this generator will be null. For any other type of exception the exception will be thrown.

Can be null:

false

getFieldGenerators

public List<com.neurosys.spider.indexer.FieldGenerator<P,Void,com.neurosys.spider.ds.processors.ObjectDocumentRowMapperIndexer>> getFieldGenerators()

Provide additional ability to generate new/additional document fields based on each product found in the Collection obtained from listForProductTransformer

setFieldGenerators

public void setFieldGenerators(List<com.neurosys.spider.indexer.FieldGenerator<P,Void,com.neurosys.spider.ds.processors.ObjectDocumentRowMapperIndexer>> fieldGenerators)

Provide additional ability to generate new/additional document fields based on each product found in the Collection obtained from listForProductTransformer