org.dspace.app.xmlui.wing.element

Class UserMeta

java.lang.Object

org.dspace.app.xmlui.wing.element.AbstractWingElement

org.dspace.app.xmlui.wing.element.UserMeta

All Implemented Interfaces:

MetadataElement, WingElement, WingMergeableElement

public class UserMeta
extends AbstractWingElement
implements WingMergeableElement, MetadataElement

A class representing a set of metadata about the user generating this page.

Author:

Scott Phillips

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	A_AUTHENTICATED The name of the authenticated attribute
static java.lang.String	E_USER_META The name of the userMeta element

Fields inherited from class org.dspace.app.xmlui.wing.element.AbstractWingElement

context

Fields inherited from interface org.dspace.app.xmlui.wing.element.MetadataElement

A_REPOSITORY_IDENTIFIER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UserMeta(WingContext context) Construct a new userMeta

Method Summary

Methods

Modifier and Type	Method and Description
Metadata	addMetadata(java.lang.String element) Add metadata about the requesting user to the document.
Metadata	addMetadata(java.lang.String element, java.lang.String qualifier) Add metadata about the requesting user to the document.
Metadata	addMetadata(java.lang.String element, java.lang.String qualifier, java.lang.String language) Add metadata about the requesting user to the document.
Metadata	addMetadata(java.lang.String element, java.lang.String qualifier, java.lang.String language, boolean allowMultiple) Add metadata about the requesting user to the document.
void	dispose() dispose
org.xml.sax.Attributes	merge(org.xml.sax.Attributes attributes) Inform this element that it is being merged with an existing element.
WingMergeableElement	mergeChild(java.lang.String namespace, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes attributes) Since metadata can not be merged there are no mergeable children.
boolean	mergeEqual(java.lang.String namespace, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes attributes) Determine if the given SAX event is a UserMeta element.
void	setAuthenticated(boolean authenticated) Set the user described in the meta object as authenticated.
void	toSAX(org.xml.sax.ContentHandler contentHandler, org.xml.sax.ext.LexicalHandler lexicalHandler, org.xml.sax.helpers.NamespaceSupport namespaces) Translate this element into SAX events.

Methods inherited from class org.dspace.app.xmlui.wing.element.AbstractWingElement

endElement, endElement, getWingContext, greater, lesser, require, require, requireFalse, requireTrue, restrict, sendCharacters, setWingContext, startElement, startElement

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

E_USER_META

public static final java.lang.String E_USER_META

The name of the userMeta element

See Also:

Constant Field Values

A_AUTHENTICATED

public static final java.lang.String A_AUTHENTICATED

The name of the authenticated attribute

See Also:

Constant Field Values

Constructor Detail

UserMeta

protected UserMeta(WingContext context)
            throws WingException

Construct a new userMeta

Parameters:

context - (Required) The context this element is contained in, such as where to route SAX events and what i18n catalogue to use.

Throws:

WingException

Method Detail

setAuthenticated

public void setAuthenticated(boolean authenticated)

Set the user described in the meta object as authenticated.

Parameters:

authenticated - (Required) True if the user is authenticated, false otherwise.

addMetadata

public Metadata addMetadata(java.lang.String element,
                   java.lang.String qualifier,
                   java.lang.String language,
                   boolean allowMultiple)
                     throws WingException

Add metadata about the requesting user to the document.

Parameters:

element - (Required) The metadata element.

qualifier - (May be null) The metadata qualifier.

language - (May be null) The metadata's language

allowMultiple - (Required) determine if multiple metadata elements with the same element, qualifier and language are allowed.

Returns:

A new metadata

Throws:

WingException

addMetadata

public Metadata addMetadata(java.lang.String element,
                   java.lang.String qualifier,
                   java.lang.String language)
                     throws WingException

Add metadata about the requesting user to the document.

Parameters:

element - (Required) The metadata element.

qualifier - (May be null) The metadata qualifier.

language - (May be null) The metadata's language

Returns:

A new metadata

Throws:

WingException

addMetadata

public Metadata addMetadata(java.lang.String element,
                   java.lang.String qualifier)
                     throws WingException

Add metadata about the requesting user to the document.

Parameters:

element - (Required) The metadata element.

qualifier - (May be null) The metadata qualifier.

Returns:

A new metadata

Throws:

WingException

addMetadata

public Metadata addMetadata(java.lang.String element)
                     throws WingException

Add metadata about the requesting user to the document.

Parameters:

element - (Required) The metadata element.

Returns:

A new metadata

Throws:

WingException

mergeEqual

public boolean mergeEqual(java.lang.String namespace,
                 java.lang.String localName,
                 java.lang.String qName,
                 org.xml.sax.Attributes attributes)
                   throws org.xml.sax.SAXException,
                          WingException

Determine if the given SAX event is a UserMeta element.

Specified by:

mergeEqual in interface WingMergeableElement

Parameters:

namespace - The element's name space

localName - The local, unqualified, name for this element

qName - The qualified name for this element

attributes - The element's attributes

Returns:

True if this WingElement is equivalent to the given SAX Event.

Throws:

org.xml.sax.SAXException

WingException

mergeChild

public WingMergeableElement mergeChild(java.lang.String namespace,
                              java.lang.String localName,
                              java.lang.String qName,
                              org.xml.sax.Attributes attributes)
                                throws org.xml.sax.SAXException,
                                       WingException

Since metadata can not be merged there are no mergeable children. This just return's null.

Specified by:

mergeChild in interface WingMergeableElement

Parameters:

namespace - The element's name space

localName - The local, unqualified, name for this element *

qName - The qualified name for this element

attributes - The element's attributes

Returns:

The child element

Throws:

org.xml.sax.SAXException

WingException

merge

public org.xml.sax.Attributes merge(org.xml.sax.Attributes attributes)
                             throws org.xml.sax.SAXException,
                                    WingException

Inform this element that it is being merged with an existing element.

Specified by:

merge in interface WingMergeableElement

Returns:

The attributes for this merged element

Throws:

org.xml.sax.SAXException

WingException

toSAX

public void toSAX(org.xml.sax.ContentHandler contentHandler,
         org.xml.sax.ext.LexicalHandler lexicalHandler,
         org.xml.sax.helpers.NamespaceSupport namespaces)
           throws org.xml.sax.SAXException

Translate this element into SAX events.

Specified by:

toSAX in interface WingElement

Parameters:

contentHandler - (Required) The registered contentHandler where SAX events should be routed too.

lexicalHandler - (Required) The registered lexicalHandler where lexical events (such as CDATA, DTD, etc) should be routed too.

namespaces - (Required) SAX Helper class to keep track of namespaces able to determine the correct prefix for a given namespace URI.

Throws:

org.xml.sax.SAXException

dispose

public void dispose()

dispose

Specified by:

dispose in interface WingElement

Overrides:

dispose in class AbstractWingElement