|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
An indexable document is a document that can be indexed with SDX.
Such a document must be able to receive SAX events that will build the fields to index, and return thoses fields to the caller.
Field Summary |
Fields inherited from interface fr.gouv.culture.sdx.document.Document |
DOCTYPE_BINARY, DOCTYPE_GROUP, DOCTYPE_HTML, DOCTYPE_USER, DOCTYPE_XML |
Method Summary | |
java.util.Enumeration |
getAttachedDocuments()
Returns an enumeration of the documentsN attached to this document |
float |
getBoost()
|
java.util.Enumeration |
getFieldValues()
Returns an enumeration of Property, one for each field defined. |
AbstractIndexableDocument.StoreHandler |
getStoreHandler()
|
java.util.Enumeration |
getSubDocuments()
Returns an enumeration of the sub(Indexable) documents attached to this document |
IndexableDocument |
getTransformedDocument()
Returns the transformed document |
void |
resetAttachedDocuments()
Reinits the Vector of attached documents |
void |
setBoost(float boost)
|
void |
setMessageHandler(org.xml.sax.ContentHandler handler)
|
void |
setTransformedDocument(byte[] content)
Allows a transformed document to be built from a byte array |
void |
setTransformedDocument(java.io.File file)
Allows a transformed document to be built from a file |
void |
startIndexing(org.apache.avalon.excalibur.xml.Parser parser,
org.apache.cocoon.xml.XMLConsumer consumer)
Starts the indexing process. |
Methods inherited from interface fr.gouv.culture.sdx.document.Document |
getDocType, getId, getLength, getMimeType, getPreferredFilename, getRepositoryForStorage, getURL, openStream, save, setContent, setContent, setContent, setContent, setId, setIdGenerator, setIdGenerator, setMimeType, setPreferredFilename, setRepositoryForStorage, setURL |
Methods inherited from interface org.apache.avalon.framework.logger.LogEnabled |
enableLogging |
Methods inherited from interface org.xml.sax.ContentHandler |
characters, endDocument, endElement, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startElement, startPrefixMapping |
Methods inherited from interface org.xml.sax.ext.LexicalHandler |
comment, endCDATA, endDTD, endEntity, startCDATA, startDTD, startEntity |
Method Detail |
public java.util.Enumeration getFieldValues()
public void startIndexing(org.apache.avalon.excalibur.xml.Parser parser, org.apache.cocoon.xml.XMLConsumer consumer) throws SDXException
SDXException
public java.util.Enumeration getAttachedDocuments()
public java.util.Enumeration getSubDocuments()
public void setTransformedDocument(byte[] content) throws SDXException
SDXException
public void setTransformedDocument(java.io.File file) throws SDXException
SDXException
public IndexableDocument getTransformedDocument()
public AbstractIndexableDocument.StoreHandler getStoreHandler()
public void setMessageHandler(org.xml.sax.ContentHandler handler)
public void setBoost(float boost)
public float getBoost()
public void resetAttachedDocuments()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |