fr.gouv.culture.sdx.user
Class Group

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
                      extended byfr.gouv.culture.sdx.user.Group
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

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 inherited from class fr.gouv.culture.sdx.document.AbstractIndexableDocument
AbstractIndexableDocument.StoreHandler
 
Field Summary
static java.lang.String NODE_NAME
          name of the object used in toSAX() methods
 
Fields inherited from class fr.gouv.culture.sdx.user.AbstractIdentity
logger
 
Fields inherited from class fr.gouv.culture.sdx.document.AbstractIndexableDocument
_boost, _currentFieldBoost, _msgHandler, 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, 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
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.avalon.excalibur.xml.Parser parser, org.apache.cocoon.xml.XMLConsumer consumer)
          Starts the indexing process.
 
Methods inherited from class fr.gouv.culture.sdx.user.AbstractIdentity
enableLogging, 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, 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
 
Methods inherited from interface fr.gouv.culture.sdx.document.Document
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

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.


Group

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

Parameters:
id - The group id.
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. 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


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