org.dspace.app.xmlui.wing.element
Class ReferenceSet

java.lang.Object
  org.dspace.app.xmlui.wing.element.AbstractWingElement
      org.dspace.app.xmlui.wing.element.ReferenceSet

All Implemented Interfaces:

StructuralElement, WingElement

public class ReferenceSet
extends AbstractWingElement
implements StructuralElement

Class representing a set of referenced metadata.

Author:

Scott Phillips

Field Summary

static String	A_ORDER_BY The name of the orderBy attribute
static String	A_TYPE The name of the type attribute
static String	E_REFERENCE_SET The name of the referenceSet element
static String	TYPE_DETAIL_LIST
static String	TYPE_DETAIL_VIEW
static String	TYPE_SUMMARY_LIST The possible interactive division methods: get,post, or multipart.
static String	TYPE_SUMMARY_VIEW
static String[]	TYPES The possible interactive division methods names collected into one array

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

context

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

A_ID, A_NAME, A_RENDER

Constructor Summary

protected

ReferenceSet(WingContext context, boolean childreference, String name, String type, String orderBy, String rend) Construct a new referenceSet

Method Summary

Reference	addReference(Object object) Add an object reference.
void	dispose() dispose
Head	setHead() Set the head element which is the label associated with this referenceset.
void	setHead(Message message) Set the head element which is the label associated with this referenceset.
void	setHead(String characters) Set the head element which is the label associated with this referenceset.
void	toSAX(ContentHandler contentHandler, LexicalHandler lexicalHandler, NamespaceSupport namespaces) Translate this metadata inclusion set to SAX

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_REFERENCE_SET

public static final String E_REFERENCE_SET

The name of the referenceSet element

See Also:

Constant Field Values

A_ORDER_BY

public static final String A_ORDER_BY

The name of the orderBy attribute

See Also:

Constant Field Values

A_TYPE

public static final String A_TYPE

The name of the type attribute

See Also:

Constant Field Values

TYPE_SUMMARY_LIST

public static final String TYPE_SUMMARY_LIST

The possible interactive division methods: get,post, or multipart.

See Also:

Constant Field Values

TYPE_SUMMARY_VIEW

public static final String TYPE_SUMMARY_VIEW

See Also:

Constant Field Values

TYPE_DETAIL_LIST

public static final String TYPE_DETAIL_LIST

See Also:

Constant Field Values

TYPE_DETAIL_VIEW

public static final String TYPE_DETAIL_VIEW

See Also:

Constant Field Values

TYPES

public static final String[] TYPES

The possible interactive division methods names collected into one array

Constructor Detail

ReferenceSet

protected ReferenceSet(WingContext context,
                       boolean childreference,
                       String name,
                       String type,
                       String orderBy,
                       String rend)
                throws WingException

Construct a new referenceSet

Parameters:

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

childreference - Whether this is a child reference (not requiring a name).

name - (May be null) a local identifier used to differentiate the element from its siblings.

type - (Required) The type of reference set which determines the level of detail for the metadata rendered. See TYPES for a list of available types.

orderBy - (May be null) Determines the ordering of referenced metadata.

rend - (May be null) a rendering hint used to override the default display of the element.

Throws:

WingException

Method Detail

setHead

public Head setHead()
             throws WingException

Set the head element which is the label associated with this referenceset.

Throws:

WingException

setHead

public void setHead(String characters)
             throws WingException

Set the head element which is the label associated with this referenceset.

Parameters:

characters - (May be null) Unprocessed characters to be referenced

Throws:

WingException

setHead

public void setHead(Message message)
             throws WingException

Set the head element which is the label associated with this referenceset.

Parameters:

message - (Required) A key into the i18n catalogue for translation into the user's preferred language.

Throws:

WingException

addReference

public Reference addReference(Object object)
                       throws WingException

Add an object reference.

Parameters:

object - (Required) The referenced object.

Throws:

WingException

toSAX

public void toSAX(ContentHandler contentHandler,
                  LexicalHandler lexicalHandler,
                  NamespaceSupport namespaces)
           throws SAXException

Translate this metadata inclusion set to SAX

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:

SAXException

dispose

public void dispose()

dispose

Specified by:

dispose in interface WingElement

Overrides:

dispose in class AbstractWingElement