fr.gouv.culture.sdx.document
Interface IndexableDocument

All Superinterfaces:
org.xml.sax.ContentHandler, Document, org.xml.sax.ext.LexicalHandler, org.apache.avalon.framework.logger.LogEnabled, org.apache.cocoon.xml.XMLConsumer
All Known Subinterfaces:
Concept, Identity
All Known Implementing Classes:
AbstractConcept, AbstractIdentity, AbstractIndexableDocument

public interface IndexableDocument
extends Document, org.apache.cocoon.xml.XMLConsumer

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
 void addAdditionalSystemFields(org.apache.lucene.document.Document doc)
          Some additional system fields adding to the Lucene document
 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

getFieldValues

public java.util.Enumeration getFieldValues()
Returns an enumeration of Property, one for each field defined.


startIndexing

public void startIndexing(org.apache.avalon.excalibur.xml.Parser parser,
                          org.apache.cocoon.xml.XMLConsumer consumer)
                   throws SDXException
Starts the indexing process.

Throws:
SDXException

getAttachedDocuments

public java.util.Enumeration getAttachedDocuments()
Returns an enumeration of the documentsN attached to this document


getSubDocuments

public java.util.Enumeration getSubDocuments()
Returns an enumeration of the sub(Indexable) documents attached to this document


setTransformedDocument

public void setTransformedDocument(byte[] content)
                            throws SDXException
Allows a transformed document to be built from a byte array

Throws:
SDXException

setTransformedDocument

public void setTransformedDocument(java.io.File file)
                            throws SDXException
Allows a transformed document to be built from a file

Throws:
SDXException

getTransformedDocument

public IndexableDocument getTransformedDocument()
Returns the transformed document


getStoreHandler

public AbstractIndexableDocument.StoreHandler getStoreHandler()

setMessageHandler

public void setMessageHandler(org.xml.sax.ContentHandler handler)

setBoost

public void setBoost(float boost)

getBoost

public float getBoost()

resetAttachedDocuments

public void resetAttachedDocuments()
Reinits the Vector of attached documents


addAdditionalSystemFields

public void addAdditionalSystemFields(org.apache.lucene.document.Document doc)
Some additional system fields adding to the Lucene document



Copyright © 2000-2004 Ministere de la culture et de la communication / AJLSM. All Rights Reserved.