fr.gouv.culture.sdx.user
Class Group

java.lang.Object
  fr.gouv.culture.sdx.utils.AbstractSdxObject
      fr.gouv.culture.sdx.document.AbstractDocument
          fr.gouv.culture.sdx.document.AbstractIndexableDocument
              fr.gouv.culture.sdx.document.XMLDocument
                  fr.gouv.culture.sdx.user.AbstractIdentity
                      fr.gouv.culture.sdx.user.Group

All Implemented Interfaces:

Document, IndexableDocument, ParsableDocument, Identity, Describable, Encodable, Identifiable, Localizable, SdxObject, org.apache.avalon.framework.configuration.Configurable, org.apache.avalon.framework.context.Contextualizable, org.apache.avalon.framework.logger.LogEnabled, org.apache.avalon.framework.service.Serviceable, org.apache.cocoon.xml.XMLProducer, org.apache.excalibur.xml.sax.XMLConsumer, org.apache.excalibur.xml.sax.XMLizable, org.xml.sax.ContentHandler, org.xml.sax.ext.LexicalHandler

public class Group
extends AbstractIdentity

A group of SDX users.

Groups are used in SDX to implement some user rights management. A group must have at least a name, but it can be backed up by a complex XML file with other kinds of information.

Nested Class Summary

Nested classes/interfaces inherited from class fr.gouv.culture.sdx.document.AbstractIndexableDocument

AbstractIndexableDocument.StoreHandler

Nested classes/interfaces inherited from interface fr.gouv.culture.sdx.utils.SdxObject

SdxObject.ConfigurationNode

Field Summary

static java.lang.String

NODE_NAME name of the object used in toSAX() methods

Fields inherited from class fr.gouv.culture.sdx.document.AbstractIndexableDocument

_boost, _currentFieldBoost, _msgHandler, _xmlFieldList, _xmlFieldOutput, _xmlFieldTransformer, attachedDocuments, contentHandler, 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, withinXmlField, 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.AbstractSdxObject

_configuration, _context, _description, _encoding, _id, _locale, _logger, _manager, _xmlizable_objects, _xmlLang, isToSaxInitialized

Fields inherited from interface fr.gouv.culture.sdx.document.Document

CLASS_NAME_SUFFIX, DOCTYPE_BINARY, DOCTYPE_GROUP, DOCTYPE_HTML, DOCTYPE_USER, DOCTYPE_XML

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

DEFAULT_ENCODING

Constructor Summary

Group()
Creates a group without information.

Group(java.lang.String id)
Creates a group given a group id.

Method Summary

java.lang.String	getDocType() Gets the docType for the document
void	startIndexing(org.apache.excalibur.xml.sax.SAXParser parser, org.apache.cocoon.xml.XMLConsumer consumer) Starts the indexing process.

Methods inherited from class fr.gouv.culture.sdx.user.AbstractIdentity

getType, setType

Methods inherited from class fr.gouv.culture.sdx.document.XMLDocument

addAdditionalSystemFields, getLength, getMimeType, openStream, parse, parse, setContent, setTransformedDocument, setTransformedDocument

Methods inherited from class fr.gouv.culture.sdx.document.AbstractIndexableDocument

addAttachedDocument, characters, comment, endCDATA, endDocument, endDTD, endElement, endEntity, endPrefixMapping, generateId, getAttachedDocuments, getAttachedDocumentsSize, getBoost, getFieldValues, getStoreHandler, getSubDocuments, getSubDocumentsSize, getTransformedDocument, handleDocumentId, ignorableWhitespace, processingInstruction, resetAttachedDocuments, resetFields, setAttachedDocuments, setBoost, setConsumer, setContentHandler, setDocumentLocator, setLexicalHandler, setMessageHandler, setUpdateAttachedDocuments, setUpTransformedDocument, setXMLFieldList, setXMLTransformerHandler, skippedEntity, startCDATA, startDocument, startDTD, startElement, startEntity, startPrefixMapping, updateAttachedDocuments

Methods inherited from class fr.gouv.culture.sdx.document.AbstractDocument

getClassNameSuffix, getInputSource, getPreferredFilename, getRepositoryForStorage, getURL, initToSax, initVolatileObjectsToSax, save, setContent, setContent, setContent, setContent, setIdGenerator, setIdGenerator, setMimeType, setPreferredFilename, setPreferredFilename, setRepositoryForStorage, setURL

Methods inherited from class fr.gouv.culture.sdx.utils.AbstractSdxObject

configure, configureDescription, contextualize, enableLogging, getBaseAttributes, getConfiguration, getContext, getDescription, getEncoding, getId, getLocale, getLog, getServiceManager, getXmlLang, service, setDescription, setEncoding, setId, setLocale, setUpSdxObject, setUpSdxObject, setXmlLang, toSAX, verifyConfigurationResources

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, setXMLFieldList, setXMLTransformerHandler

Methods inherited from interface fr.gouv.culture.sdx.document.Document

getLength, getMimeType, getPreferredFilename, getRepositoryForStorage, getURL, openStream, save, setContent, setContent, setContent, setContent, setId, setIdGenerator, setIdGenerator, setMimeType, setPreferredFilename, setRepositoryForStorage, setURL

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

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 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

NODE_NAME

public static final java.lang.String NODE_NAME

name of the object used in toSAX() methods

See Also:

Constant Field Values

Constructor Detail

Group

public Group()
      throws SDXException

Creates a group without information. The name must be supplied at indexing time.

Throws:

SDXException

Group

public Group(java.lang.String id)
      throws SDXException

Creates a group given a group id.

Parameters:

id - The group id.

Throws:

SDXException

Method Detail

startIndexing

public void startIndexing(org.apache.excalibur.xml.sax.SAXParser parser,
                          org.apache.cocoon.xml.XMLConsumer consumer)
                   throws SDXException

Starts the indexing process. For users, it must return at least a "name" field.

Indexing is done in the usual way but at the end we keep specific user information and make them available for the getters.

Specified by:

startIndexing in interface IndexableDocument

Overrides:

startIndexing in class XMLDocument

Parameters:

parser - A parser that can be used for the indexing.

consumer - The consumer that is the target of the indexing (may be null. The previously provided consumer will then be used) TODO?:what does this mean?-rbp

Throws:

SDXException

getDocType

public java.lang.String getDocType()

Gets the docType for the document

Specified by:

getDocType in interface Document

Overrides:

getDocType in class XMLDocument