fr.gouv.culture.sdx.user
Class AbstractIdentity

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.XMLDocument
                  extended byfr.gouv.culture.sdx.user.AbstractIdentity
All Implemented Interfaces:
org.xml.sax.ContentHandler, Document, Identity, IndexableDocument, org.xml.sax.ext.LexicalHandler, org.apache.avalon.framework.logger.LogEnabled, ParsableDocument, SdxObject, org.apache.cocoon.xml.XMLConsumer, org.apache.cocoon.xml.XMLProducer
Direct Known Subclasses:
Group, User

public abstract class AbstractIdentity
extends XMLDocument
implements Identity, org.apache.avalon.framework.logger.LogEnabled

An abstract and simple implementation of an identity using an XML document.

This abstract class takes care of the name and type methods. By extending XMLdocument, it also takes care of most of the indexing process.


Nested Class Summary
 
Nested classes inherited from class fr.gouv.culture.sdx.document.AbstractIndexableDocument
AbstractIndexableDocument.StoreHandler
 
Field Summary
protected  org.apache.avalon.framework.logger.Logger logger
          Avalon logger to write information.
 
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
 
Fields inherited from interface fr.gouv.culture.sdx.document.Document
DOCTYPE_BINARY, DOCTYPE_GROUP, DOCTYPE_HTML, DOCTYPE_USER, DOCTYPE_XML
 
Constructor Summary
AbstractIdentity()
          Creates an empty identity.
AbstractIdentity(java.lang.String id)
          Creates an identity with a given id.
 
Method Summary
 void enableLogging(org.apache.avalon.framework.logger.Logger logger)
          Provides a logger
 int getType()
          Deprecated. Use getDoctype()
 void setType(int type)
          Sets the type of this identity (@see ???).
 
Methods inherited from class fr.gouv.culture.sdx.document.XMLDocument
addAdditionalSystemFields, getDocType, getLength, getMimeType, openStream, parse, parse, setContent, setTransformedDocument, setTransformedDocument, startIndexing
 
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, 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
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.IndexableDocument
addAdditionalSystemFields, getAttachedDocuments, getBoost, getFieldValues, getStoreHandler, getSubDocuments, getTransformedDocument, resetAttachedDocuments, setBoost, setMessageHandler, setTransformedDocument, setTransformedDocument, startIndexing
 
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.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
 
Methods inherited from interface org.apache.cocoon.xml.XMLProducer
setConsumer
 

Field Detail

logger

protected org.apache.avalon.framework.logger.Logger logger
Avalon logger to write information.

Constructor Detail

AbstractIdentity

public AbstractIdentity()
                 throws SDXException
Creates an empty identity.

Throws:
SDXException - if identity can not be built

AbstractIdentity

public AbstractIdentity(java.lang.String id)
                 throws SDXException
Creates an identity with a given id.

Parameters:
id - An id for the identity.
Throws:
SDXException - if identity can not be built
Method Detail

getType

public int getType()
Deprecated. Use getDoctype()

Returns the type of identity.

Returns:
The type.

setType

public void setType(int type)
Sets the type of this identity (@see ???).

Parameters:
type - The identity type.

enableLogging

public void enableLogging(org.apache.avalon.framework.logger.Logger logger)
Provides a logger

Specified by:
enableLogging in interface org.apache.avalon.framework.logger.LogEnabled
Overrides:
enableLogging in class SdxObjectImpl
Parameters:
logger - The logger


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