|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Document
This interface encapsulates the concept of a document during indexing. Implementors of this interface as responsible for parsing and tokenising a document (eg parse the HTML tags, output the text terms found).
Method Summary | |
---|---|
boolean |
endOfDocument()
Returns true when the end of the document has been reached, and there are no other terms to be retrieved from it. |
java.util.Map<java.lang.String,java.lang.String> |
getAllProperties()
Returns the underlying map of all the properties defined by this Document. |
java.util.Set<java.lang.String> |
getFields()
Returns a list of the fields the current term appears in. |
java.lang.String |
getNextTerm()
Gets the next term of the document. |
java.lang.String |
getProperty(java.lang.String name)
Allows access to a named property of the Document. |
java.io.Reader |
getReader()
Returns a Reader object so client code can tokenise the document or deal with the document itself. |
Method Detail |
---|
java.lang.String getNextTerm()
java.util.Set<java.lang.String> getFields()
boolean endOfDocument()
java.io.Reader getReader()
java.lang.String getProperty(java.lang.String name)
name
- Name of the property. It is suggested, but not required that this name
should not be case insensitive.java.util.Map<java.lang.String,java.lang.String> getAllProperties()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |