net.ontopia.infoset.fulltext.utils
Class Locator2ContentProcessor

java.lang.Object
  net.ontopia.infoset.fulltext.utils.AbstractLocatorDocumentProcessor
      net.ontopia.infoset.fulltext.utils.Locator2ContentProcessor

All Implemented Interfaces:

DocumentProcessorIF

public class Locator2ContentProcessor
extends AbstractLocatorDocumentProcessor

INTERNAL: A document processor that replaces notation and address fields with a reader field.

Field Summary

protected java.lang.String	content_field
protected LocatorReaderFactoryIF	lrf

Fields inherited from class net.ontopia.infoset.fulltext.utils.AbstractLocatorDocumentProcessor

address_field, notation_field

Constructor Summary

Locator2ContentProcessor(LocatorReaderFactoryIF lrf)

Locator2ContentProcessor(LocatorReaderFactoryIF lrf, java.lang.String notation_field, java.lang.String address_field, java.lang.String content_field)

Method Summary

java.lang.String	getContentField() INTERNAL: Gets the name of the content field.
boolean	needsProcessing(DocumentIF document) INTERNAL: Can be used to figure out if it is necessary to process the document.
void	process(DocumentIF document) INTERNAL: Processes the specified document.
void	setContentField(java.lang.String content_field) INTERNAL: Sets the name of the content field.

Methods inherited from class net.ontopia.infoset.fulltext.utils.AbstractLocatorDocumentProcessor

getAddressField, getLocator, getNotationField, setAddressField, setNotationField

Methods inherited from class java.lang.Object

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

Field Detail

content_field

protected java.lang.String content_field

lrf

protected LocatorReaderFactoryIF lrf

Constructor Detail

Locator2ContentProcessor

public Locator2ContentProcessor(LocatorReaderFactoryIF lrf)

Locator2ContentProcessor

public Locator2ContentProcessor(LocatorReaderFactoryIF lrf,
                                java.lang.String notation_field,
                                java.lang.String address_field,
                                java.lang.String content_field)

Method Detail

getContentField

public java.lang.String getContentField()

INTERNAL: Gets the name of the content field. This is the field in which the Reader will be stored.

setContentField

public void setContentField(java.lang.String content_field)

INTERNAL: Sets the name of the content field.

process

public void process(DocumentIF document)
             throws java.lang.Exception

Description copied from interface: DocumentProcessorIF

INTERNAL: Processes the specified document.

Throws:

java.lang.Exception

needsProcessing

public boolean needsProcessing(DocumentIF document)

Description copied from interface: DocumentProcessorIF

INTERNAL: Can be used to figure out if it is necessary to process the document.

This method should be used to quickly decide whether or not the document needs to be processed. Note that this method should return quickly, since it would normally be executed serially.

Returns:

Returns true if the document should be processed.