fr.gouv.culture.sdx.documentbase
Interface DocumentBase

All Superinterfaces:

org.apache.avalon.framework.configuration.Configurable, org.apache.avalon.framework.context.Contextualizable, Describable, Encodable, Identifiable, Localizable, org.apache.avalon.framework.logger.LogEnabled, Saveable, SdxObject, Searchable, org.apache.avalon.framework.service.Serviceable, org.apache.excalibur.xml.sax.XMLizable

All Known Subinterfaces:

SDXThesaurus

All Known Implementing Classes:

AbstractDocumentBase, AbstractThesaurus, LuceneDocumentBase, LuceneThesaurus, SDXDocumentBase

public interface DocumentBase
extends SdxObject, Searchable, Saveable

A location where documents are indexed, stored, searched and retrieved.

Nested Class Summary

static interface

DocumentBase.ConfigurationNode

Field Summary

static java.lang.String	CLASS_NAME_SUFFIX The document base's class name suffix.
static java.lang.String	PACKAGE_QUALNAME The document base's package name (including trailing separator ".").

Fields inherited from interface fr.gouv.culture.sdx.utils.Encodable

DEFAULT_ENCODING

Fields inherited from interface fr.gouv.culture.sdx.utils.save.Saveable

ALL_SAVE_ATTRIB, PATH_ATTRIB, SAVE_DIRECTORY_PARAM

Method Summary

void	checkIntegrity() Check the integrity of the documentBase
OAIRepository	createOAIRepository() Creates an OAIRepository for the documentbase
java.util.Date	creationDate() Returns the creation date of the document base
void	delete(Document[] docs, org.xml.sax.ContentHandler handler) Deletes documents.
void	delete(Document doc, org.xml.sax.ContentHandler handler) Deletes a document.
int	getDefaultHitsPerPage() Returns the default number of results on page for this DocumentBase.
int	getDefaultMaxSort() Returns the default maximum number of results to sort for this DocumentBase.
Repository	getDefaultRepository() Returns the default repository for the DocumentBase.
java.io.InputStream	getDocument(Document doc) Provides the requested SDX document as an InputStream.
void	getDocument(Document doc, java.io.OutputStream os) Supplies the provided output stream with the requested document
void	getDocument(ParsableDocument doc, org.apache.cocoon.xml.XMLConsumer consumer) Sends a document as SAX events.
void	getDocument(ParsableDocument doc, org.apache.cocoon.xml.XMLConsumer consumer, boolean docTypeKnown) Sends a document as SAX events.
Pipeline	getIndexationPipeline() Returns the default indexation pipeline used for indexation in this document base.
java.lang.String	getMimeType(Document doc) Supplies the mimeType for the the document if it exists.
OAIHarvester	getOAIHarvester() Gets the AbstractDocumentBaseOAIHarvester for the documentbase if one exists
int	getOAIRepositoriesSize() Returns the number of OAI repositories managed by this document base
OAIRepository	getOAIRepository() Gets the default OAIRepository for the documentbase if one exists
OAIRepository	getOAIRepository(java.lang.String repo) Returns the specified OAI repository
Repository	getRepository(java.lang.String id) Returns a repository which is owned by this document base using its id.
org.apache.excalibur.source.SourceValidity	getSourceValidity() Returns a source validity object for this document base (for caching)
void	index(IndexableDocument[] docs, Repository repository, IndexParameters params, org.xml.sax.ContentHandler handler) Indexes documents and stores them in a repository.
void	index(IndexableDocument doc, Repository repository, IndexParameters params, org.xml.sax.ContentHandler handler) Indexes a document and stores it in a repository.
void	init() Initializes the document base.
boolean	isDefault() Returns true if this document base is the default in the application.
java.util.Date	lastModificationDate() Returns the last modification date of the document base
void	optimize() Process an optimization of the documentbase.

Methods inherited from interface fr.gouv.culture.sdx.utils.SdxObject

getLog

Methods inherited from interface org.apache.avalon.framework.logger.LogEnabled

enableLogging

Methods inherited from interface org.apache.avalon.framework.context.Contextualizable

contextualize

Methods inherited from interface org.apache.avalon.framework.service.Serviceable

service

Methods inherited from interface org.apache.avalon.framework.configuration.Configurable

configure

Methods inherited from interface fr.gouv.culture.sdx.utils.Identifiable

getId, setId

Methods inherited from interface fr.gouv.culture.sdx.utils.Describable

getDescription, setDescription

Methods inherited from interface fr.gouv.culture.sdx.utils.Encodable

getEncoding, setEncoding

Methods inherited from interface fr.gouv.culture.sdx.utils.Localizable

getLocale, getXmlLang, setLocale, setXmlLang

Methods inherited from interface org.apache.excalibur.xml.sax.XMLizable

toSAX

Methods inherited from interface fr.gouv.culture.sdx.search.Searchable

getId, getIndex

Methods inherited from interface fr.gouv.culture.sdx.utils.save.Saveable

backup, restore

Field Detail

PACKAGE_QUALNAME

static final java.lang.String PACKAGE_QUALNAME

The document base's package name (including trailing separator ".").

See Also:

Constant Field Values

CLASS_NAME_SUFFIX

static final java.lang.String CLASS_NAME_SUFFIX

The document base's class name suffix.

See Also:

Constant Field Values

Method Detail

init

void init()
          throws SDXException,
                 org.apache.avalon.framework.configuration.ConfigurationException

Initializes the document base.

This method must be called after the super.getLog() has been set and the configuration done.

Throws:

SDXException

org.apache.avalon.framework.configuration.ConfigurationException

isDefault

boolean isDefault()

Returns true if this document base is the default in the application.

getDefaultHitsPerPage

int getDefaultHitsPerPage()

Returns the default number of results on page for this DocumentBase.

Returns:

The default hpp for the DocumentBase

getDefaultMaxSort

int getDefaultMaxSort()

Returns the default maximum number of results to sort for this DocumentBase.

Returns:

The default maxsort for the DocumentBase

getRepository

Repository getRepository(java.lang.String id)
                         throws SDXException

Returns a repository which is owned by this document base using its id.

Parameters:

id - The requested repository's id.

Returns:

The requested repository, or the default repository is the id doesn't match any repository id. TODO : dangerous behaviour IMHO -pb

Throws:

SDXException

getDefaultRepository

Repository getDefaultRepository()

Returns the default repository for the DocumentBase.

getIndexationPipeline

Pipeline getIndexationPipeline()

Returns the default indexation pipeline used for indexation in this document base.

index

void index(IndexableDocument doc,
           Repository repository,
           IndexParameters params,
           org.xml.sax.ContentHandler handler)
           throws SDXException,
                  org.xml.sax.SAXException,
                  org.apache.cocoon.ProcessingException

Indexes a document and stores it in a repository.

Parameters:

doc - The document to index and add.

repository - The repository where the document have to be stored.

params - Parameters governing the indexing process.

handler - The SAX events consumer that receives informations about the indexing process.

Throws:

SDXException

org.xml.sax.SAXException

org.apache.cocoon.ProcessingException

index

void index(IndexableDocument[] docs,
           Repository repository,
           IndexParameters params,
           org.xml.sax.ContentHandler handler)
           throws SDXException,
                  org.xml.sax.SAXException,
                  org.apache.cocoon.ProcessingException

Indexes documents and stores them in a repository.

Parameters:

docs - The documents to index and add.

repository - The repository where the documents have to be stored.

params - Parameters governing the indexing process.

handler - The SAX events consumer that receives informations about the indexing process.

Throws:

SDXException

org.xml.sax.SAXException

org.apache.cocoon.ProcessingException

delete

void delete(Document doc,
            org.xml.sax.ContentHandler handler)
            throws SDXException,
                   org.xml.sax.SAXException,
                   org.apache.cocoon.ProcessingException

Deletes a document.

Parameters:

doc - The id of the document to delete.

handler - The SAX events consumer that receives informations about the deletion process.

Throws:

SDXException

org.xml.sax.SAXException

org.apache.cocoon.ProcessingException

delete

void delete(Document[] docs,
            org.xml.sax.ContentHandler handler)
            throws SDXException,
                   org.xml.sax.SAXException,
                   org.apache.cocoon.ProcessingException

Deletes documents.

Parameters:

docs - The documents to delete.

handler - The SAX events consumer that receives informations about the deletion process.

Throws:

SDXException

org.xml.sax.SAXException

org.apache.cocoon.ProcessingException

getDocument

void getDocument(ParsableDocument doc,
                 org.apache.cocoon.xml.XMLConsumer consumer)
                 throws SDXException

Sends a document as SAX events.

Parameters:

doc - A ParsableDocument, i.e. XMLDocument or HTMLDocument.

consumer - A SAX content handler to feed with events. The wrapped contentHandler for including events within an XSP page contentHandler should be created using IncludeXMLConsumer stripper = new IncludeXMLConsumer(xspContentHandler); and then the "stripper" should be passed to this method

Throws:

SDXException

getDocument

void getDocument(ParsableDocument doc,
                 org.apache.cocoon.xml.XMLConsumer consumer,
                 boolean docTypeKnown)
                 throws SDXException

Sends a document as SAX events.

Parameters:

doc - A ParsableDocument, i.e. XMLDocument or HTMLDocument.

consumer - A SAX content handler to feed with events.

docTypeKnown - If set to false implementations should attempt to determine the doctyp(see LuceneDocumentBase) The wrapped contentHandler for including events within an XSP page contentHandler should be created using IncludeXMLConsumer stripper = new IncludeXMLConsumer(xspContentHandler); and then the "stripper" should be passed to this method

Throws:

SDXException

getDocument

void getDocument(Document doc,
                 java.io.OutputStream os)
                 throws SDXException

Supplies the provided output stream with the requested document

Parameters:

doc - The document.

os - The output stream.

Throws:

SDXException

getDocument

java.io.InputStream getDocument(Document doc)
                                throws SDXException

Provides the requested SDX document as an InputStream.

Parameters:

doc - The document.

Returns:

An input stream.

Throws:

SDXException

getMimeType

java.lang.String getMimeType(Document doc)
                             throws SDXException

Supplies the mimeType for the the document if it exists. otherwise the default mimetype should be returned TODO : dangerous behaviour IMHO -pb

Parameters:

doc - The document.

Throws:

SDXException

createOAIRepository

OAIRepository createOAIRepository()
                                  throws org.apache.avalon.framework.configuration.ConfigurationException

Creates an OAIRepository for the documentbase

Returns:

Throws:

org.apache.avalon.framework.configuration.ConfigurationException

getOAIRepository

OAIRepository getOAIRepository()

Gets the default OAIRepository for the documentbase if one exists

Returns:

OAIRepository

getOAIRepository

OAIRepository getOAIRepository(java.lang.String repo)

Returns the specified OAI repository

Parameters:

repo - String The repository id

Returns:

OAIRepository

getOAIRepositoriesSize

int getOAIRepositoriesSize()

Returns the number of OAI repositories managed by this document base

Returns:

The number of OAI repositories as an int

getOAIHarvester

OAIHarvester getOAIHarvester()

Gets the AbstractDocumentBaseOAIHarvester for the documentbase if one exists

Returns:

OAIHarvester

lastModificationDate

java.util.Date lastModificationDate()

Returns the last modification date of the document base

creationDate

java.util.Date creationDate()

Returns the creation date of the document base

optimize

void optimize()

Process an optimization of the documentbase. Can be left empty in implementation but must be present. Should be synchronized in implementations...

checkIntegrity

void checkIntegrity()

Check the integrity of the documentBase

getSourceValidity

org.apache.excalibur.source.SourceValidity getSourceValidity()

Returns a source validity object for this document base (for caching)