fr.gouv.culture.sdx.document
Class HTMLDocument

java.lang.Object
  extended byfr.gouv.culture.sdx.utils.SdxObjectImpl
      extended byfr.gouv.culture.sdx.document.AbstractDocument
          extended byfr.gouv.culture.sdx.document.AbstractIndexableDocument
              extended byfr.gouv.culture.sdx.document.HTMLDocument
All Implemented Interfaces:
org.xml.sax.ContentHandler, Document, IndexableDocument, org.xml.sax.ext.LexicalHandler, org.apache.avalon.framework.logger.LogEnabled, ParsableDocument, SdxObject, org.apache.cocoon.xml.XMLConsumer, org.apache.cocoon.xml.XMLProducer

public class HTMLDocument
extends AbstractIndexableDocument
implements ParsableDocument

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.AbstractIndexableDocument
addAttachedDocument, characters, comment, endCDATA, endDocument, endDTD, endElement, endEntity, endPrefixMapping, generateId, getAttachedDocuments, getBoost, getFieldValues, getStoreHandler, getSubDocuments, getTransformedDocument, handleDocumentId, ignorableWhitespace, processingInstruction, resetAttachedDocuments, resetFields, setAttachedDocuments, setBoost, setConsumer, setContentHandler, setDocumentLocator, setLexicalHandler, setMessageHandler, setUpdateAttachedDocuments, setUpTransformedDocument, skippedEntity, startCDATA, startDocument, startDTD, startElement, startEntity, startPrefixMapping, updateAttachedDocuments
 
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

tidyConf

protected java.io.File tidyConf
Constructor Detail

HTMLDocument

public HTMLDocument(java.lang.String id)
             throws SDXException
Creates an HTML document given an id.

Parameters:
id - The document's id. If logging is desired the logger should be set after creation.
See Also:
SdxObjectImpl.enableLogging(org.apache.avalon.framework.logger.Logger)

HTMLDocument

public HTMLDocument()
Creates an HTML document. The document's id must be given later. If logging is desired the logger should be set after creation.

See Also:
SdxObjectImpl.enableLogging(org.apache.avalon.framework.logger.Logger)
Method Detail

startIndexing

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

Specified by:
startIndexing in interface IndexableDocument
Parameters:
parser - The parser to use
consumer - The consumer for the events generated by the indexing process
Throws:
SDXException

parse

public void parse(org.apache.avalon.excalibur.xml.Parser parser)
           throws SDXException
Parses a document using the previously supplied consumer.

Specified by:
parse in interface ParsableDocument
Parameters:
parser - The parser to use.
Throws:
SDXException

parse

public void parse(org.apache.avalon.excalibur.xml.Parser parser,
                  org.apache.cocoon.xml.XMLConsumer consumer)
           throws SDXException
Parses a document using a specific consumer.

Specified by:
parse in interface ParsableDocument
Parameters:
parser - The parser to use
consumer - The consumer of the events generated by the parse
Throws:
SDXException

getDocType

public java.lang.String getDocType()
Gets the docType for the document

Specified by:
getDocType in interface Document

setTransformedDocument

public void setTransformedDocument(byte[] content)
                            throws SDXException
Set's the transformed document for the parent document. The transformed document will have the same id and preferred filename as the original.

Specified by:
setTransformedDocument in interface IndexableDocument
Parameters:
content - The byte array of data
Throws:
SDXException

setTransformedDocument

public void setTransformedDocument(java.io.File file)
                            throws SDXException
Set's the transformed document for the parent document. The transformed document will have the same id and preferred filename as the original.

Specified by:
setTransformedDocument in interface IndexableDocument
Parameters:
file - The transformed document file
Throws:
SDXException

getMimeType

public java.lang.String getMimeType()
Returns the mimeType field (A String) for this document

Specified by:
getMimeType in interface Document
Overrides:
getMimeType in class AbstractDocument

setTidyConfiguration

public void setTidyConfiguration(java.io.File tidyConf)

addAdditionalSystemFields

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

Specified by:
addAdditionalSystemFields in interface IndexableDocument


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