edu.mayo.informatics.indexer.api.generators
Class DocumentFromStringsGenerator

java.lang.Object
  extended by edu.mayo.informatics.indexer.api.generators.DocumentFromStringsGenerator

public class DocumentFromStringsGenerator
extends java.lang.Object

This class assists in building 'proper' documents for the index.

Author:
Dan Armbrust

Constructor Summary
DocumentFromStringsGenerator()
           
 
Method Summary
 void addDateField(java.lang.String name, java.util.Date value, boolean store, boolean index)
           
 void addDateField(java.lang.String name, long value, boolean store, boolean index)
           
 void addIntField(java.lang.String name, int value, int padToLength, boolean store, boolean index)
           
 void addTextField(java.lang.String name, java.lang.String value, boolean store, boolean index, boolean tokenize)
           
 void addTextField(java.lang.String name, java.lang.String value, boolean store, boolean compress, boolean index, boolean tokenize)
           
 org.apache.lucene.document.Document getDocument()
           
 void startNewDocument(java.lang.String documentIdentifier)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DocumentFromStringsGenerator

public DocumentFromStringsGenerator()
Method Detail

startNewDocument

public void startNewDocument(java.lang.String documentIdentifier)
                      throws InvalidValueException
Throws:
InvalidValueException

getDocument

public org.apache.lucene.document.Document getDocument()
                                                throws OperatorErrorException
Throws:
OperatorErrorException

addTextField

public void addTextField(java.lang.String name,
                         java.lang.String value,
                         boolean store,
                         boolean index,
                         boolean tokenize)
                  throws InvalidValueException,
                         OperatorErrorException
Throws:
InvalidValueException
OperatorErrorException

addTextField

public void addTextField(java.lang.String name,
                         java.lang.String value,
                         boolean store,
                         boolean compress,
                         boolean index,
                         boolean tokenize)
                  throws InvalidValueException,
                         OperatorErrorException
Throws:
InvalidValueException
OperatorErrorException

addIntField

public void addIntField(java.lang.String name,
                        int value,
                        int padToLength,
                        boolean store,
                        boolean index)
                 throws InvalidValueException,
                        OperatorErrorException
Throws:
InvalidValueException
OperatorErrorException

addDateField

public void addDateField(java.lang.String name,
                         java.util.Date value,
                         boolean store,
                         boolean index)
                  throws InvalidValueException,
                         OperatorErrorException
Throws:
InvalidValueException
OperatorErrorException

addDateField

public void addDateField(java.lang.String name,
                         long value,
                         boolean store,
                         boolean index)
                  throws InvalidValueException,
                         OperatorErrorException
Throws:
InvalidValueException
OperatorErrorException

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

Copyright: (c) 2004-2006 Mayo Foundation for Medical Education and Research (MFMER). All rights reserved. MAYO, MAYO CLINIC, and the triple-shield Mayo logo are trademarks and service marks of MFMER.