|
||||||||||
| 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.HTMLDocument
An HTML document, parsable and indexable.
| Nested Class Summary |
| Nested classes inherited from class fr.gouv.culture.sdx.document.AbstractIndexableDocument |
AbstractIndexableDocument.StoreHandler |
| Field Summary | |
protected java.io.File |
tidyConf
|
| 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 | |
HTMLDocument()
Creates an HTML document. |
|
HTMLDocument(java.lang.String id)
Creates an HTML document given an 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 |
java.lang.String |
getMimeType()
Returns the mimeType field (A String) for this document |
void |
parse(org.apache.avalon.excalibur.xml.Parser parser)
Parses a document using the previously supplied consumer. |
void |
parse(org.apache.avalon.excalibur.xml.Parser parser,
org.apache.cocoon.xml.XMLConsumer consumer)
Parses a document using a specific consumer. |
void |
setTidyConfiguration(java.io.File tidyConf)
|
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, getLength, getPreferredFilename, getRepositoryForStorage, getURL, openStream, 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, getLength, 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.apache.cocoon.xml.XMLProducer |
setConsumer |
| Field Detail |
protected java.io.File tidyConf
| Constructor Detail |
public HTMLDocument(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 HTMLDocument()
SdxObjectImpl.enableLogging(org.apache.avalon.framework.logger.Logger)| Method Detail |
public void startIndexing(org.apache.avalon.excalibur.xml.Parser parser,
org.apache.cocoon.xml.XMLConsumer consumer)
throws SDXException
startIndexing in interface IndexableDocumentparser - 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)
throws SDXException
parse in interface ParsableDocumentparser - The parser to use.
SDXException
public void parse(org.apache.avalon.excalibur.xml.Parser parser,
org.apache.cocoon.xml.XMLConsumer consumer)
throws SDXException
parse in interface ParsableDocumentparser - The parser to useconsumer - The consumer of the events generated by the parse
SDXExceptionpublic java.lang.String getDocType()
getDocType in interface Document
public void setTransformedDocument(byte[] content)
throws SDXException
setTransformedDocument in interface IndexableDocumentcontent - The byte array of data
SDXException
public void setTransformedDocument(java.io.File file)
throws SDXException
setTransformedDocument in interface IndexableDocumentfile - The transformed document file
SDXExceptionpublic java.lang.String getMimeType()
getMimeType in interface DocumentgetMimeType in class AbstractDocumentpublic void setTidyConfiguration(java.io.File tidyConf)
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 | |||||||||