|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfr.gouv.culture.sdx.utils.SdxObjectImpl
fr.gouv.culture.sdx.document.AbstractDocument
fr.gouv.culture.sdx.document.AbstractIndexableDocument
fr.gouv.culture.sdx.document.XMLDocument
An XML document, parsable and indexable.
Nested Class Summary |
Nested classes inherited from class fr.gouv.culture.sdx.document.AbstractIndexableDocument |
AbstractIndexableDocument.StoreHandler |
Field Summary |
Fields inherited from class fr.gouv.culture.sdx.document.AbstractIndexableDocument |
_boost, _currentFieldBoost, _msgHandler, attachedDocuments, characterBuffer, contentHandler, currentFieldName, DOC_ATTACHEDOC_ELEMENT_NAME, DOC_FIELD_ELEMENT_NAME, DOC_MSG_ELEMENT_NAME, DOC_NAMESPACE, DOC_ROOT_ELEMENT_NAME, lexicalHandler, nsTable, openSdxDocElems, properties, storeHandler, subDoc, subDocBytes, subDocuments, transformedDoc, withinSdxElement, xmlConsumer |
Fields inherited from class fr.gouv.culture.sdx.document.AbstractDocument |
idGenerator, idPrefix, idSuffix, mimeType, storeRepo |
Fields inherited from class fr.gouv.culture.sdx.utils.SdxObjectImpl |
encoding, logger |
Fields inherited from interface fr.gouv.culture.sdx.document.Document |
DOCTYPE_BINARY, DOCTYPE_GROUP, DOCTYPE_HTML, DOCTYPE_USER, DOCTYPE_XML |
Constructor Summary | |
XMLDocument()
Creates a document. |
|
XMLDocument(java.lang.String id)
Creates a document with a given id. |
Method Summary | |
void |
addAdditionalSystemFields(org.apache.lucene.document.Document doc)
Some additional system fields adding to the Lucene document |
java.lang.String |
getDocType()
Gets the docType for the document |
int |
getLength()
Returns the length of the document. |
java.lang.String |
getMimeType()
Returns the mimeType field (A String) for this document |
java.io.InputStream |
openStream()
Opens a stream for reading the document's content. |
void |
parse(org.apache.avalon.excalibur.xml.Parser parser)
Parses the document. |
void |
parse(org.apache.avalon.excalibur.xml.Parser parser,
org.apache.cocoon.xml.XMLConsumer consumer)
Parses a document using a specific consumer. |
void |
setContent(org.w3c.dom.Document d)
Set the content as a DOM. |
void |
setTransformedDocument(byte[] content)
Set's the transformed document for the parent document. |
void |
setTransformedDocument(java.io.File file)
Set's the transformed document for the parent document. |
void |
startIndexing(org.apache.avalon.excalibur.xml.Parser parser,
org.apache.cocoon.xml.XMLConsumer consumer)
Starts the indexing process. |
Methods inherited from class fr.gouv.culture.sdx.document.AbstractDocument |
getId, getInputSource, getPreferredFilename, getRepositoryForStorage, getURL, save, setContent, setContent, setContent, setContent, setId, setIdGenerator, setIdGenerator, setMimeType, setPreferredFilename, setPreferredFilename, setRepositoryForStorage, setURL |
Methods inherited from class fr.gouv.culture.sdx.utils.SdxObjectImpl |
enableLogging, getChildLogger, setEncoding |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface fr.gouv.culture.sdx.document.Document |
getId, getPreferredFilename, getRepositoryForStorage, getURL, 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.apache.cocoon.xml.XMLProducer |
setConsumer |
Constructor Detail |
public XMLDocument(java.lang.String id) throws SDXException
id
- The document's id.
If logging is desired the logger should be set after creation.SdxObjectImpl.enableLogging(org.apache.avalon.framework.logger.Logger)
public XMLDocument()
SdxObjectImpl.enableLogging(org.apache.avalon.framework.logger.Logger)
Method Detail |
public java.io.InputStream openStream() throws SDXException
openStream
in interface Document
openStream
in class AbstractDocument
SDXException
public void setContent(org.w3c.dom.Document d)
public int getLength()
getLength
in interface Document
getLength
in class AbstractDocument
public void parse(org.apache.avalon.excalibur.xml.Parser parser) throws SDXException
parse
in interface ParsableDocument
parser
- The parser to use
SDXException
public void startIndexing(org.apache.avalon.excalibur.xml.Parser parser, org.apache.cocoon.xml.XMLConsumer consumer) throws SDXException
startIndexing
in interface IndexableDocument
parser
- The parser to useconsumer
- The consumer for the events generated by the indexing process
SDXException
public void parse(org.apache.avalon.excalibur.xml.Parser parser, org.apache.cocoon.xml.XMLConsumer consumer) throws SDXException
parse
in interface ParsableDocument
parser
- The parser to useconsumer
- The consumer of the events generated by the parse
SDXException
public java.lang.String getDocType()
getDocType
in interface Document
public void setTransformedDocument(byte[] content) throws SDXException
setTransformedDocument
in interface IndexableDocument
content
- The byte array of data
SDXException
public void setTransformedDocument(java.io.File file) throws SDXException
setTransformedDocument
in interface IndexableDocument
file
- The transformed document file
SDXException
public java.lang.String getMimeType()
getMimeType
in interface Document
getMimeType
in class AbstractDocument
public void addAdditionalSystemFields(org.apache.lucene.document.Document doc)
addAdditionalSystemFields
in interface IndexableDocument
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |