buri.ddmsence.ddms.resource

Class Title

Object

buri.ddmsence.AbstractBaseComponent

buri.ddmsence.AbstractSimpleString

buri.ddmsence.ddms.resource.Title

All Implemented Interfaces:

IDDMSComponent

public final class Title
extends AbstractSimpleString

An immutable implementation of ddms:title.

Strictness
DDMSence is stricter than the specification in the following ways: The title child text must not be empty.

Attributes
SecurityAttributes: The classification and ownerProducer attributes are required.

Since:

0.9.b

Author:

Brian Uri!

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Title.Builder Builder for this DDMS component.

Constructor Summary

Constructors

Constructor and Description
Title(nu.xom.Element element) Constructor for creating a component from a XOM Element
Title(String title, SecurityAttributes securityAttributes) Constructor for creating a component from raw data

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Test for logical equality.
static String	getName(DDMSVersion version) Accessor for the element name of this component, based on the version of DDMS used
String	getOutput(boolean isHTML, String prefix, String suffix) Renders this component as HTML or Text, with an optional prefix to nest it.
protected void	validate() Validates the component.

Methods inherited from class buri.ddmsence.AbstractSimpleString

getSecurityAttributes, getValue, hashCode

Methods inherited from class buri.ddmsence.AbstractBaseComponent

addDdms40Warning, addWarning, addWarnings, buildIndex, buildOutput, buildOutput, buildPrefix, getAttributeValue, getAttributeValue, getChild, getChildTextAsDouble, getDDMSVersion, getLocatorSuffix, getName, getNamespace, getNestedComponents, getPrefix, getQualifiedName, getStringAsDouble, getValidationWarnings, getXOMElement, getXOMElementCopy, requireVersion, setXOMElement, toHTML, toString, toText, toXML, validateWarnings

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Title

public Title(nu.xom.Element element)
      throws InvalidDDMSException

Constructor for creating a component from a XOM Element

Parameters:

element - the XOM element representing this

Throws:

InvalidDDMSException - if any required information is missing or malformed

Title

public Title(String title,
     SecurityAttributes securityAttributes)
      throws InvalidDDMSException

Constructor for creating a component from raw data

Parameters:

title - the value of the title child text

securityAttributes - any security attributes (classification and ownerProducer are required)

Throws:

InvalidDDMSException - if any required information is missing or malformed

Method Detail

validate

protected void validate()
                 throws InvalidDDMSException

Validates the component.

Rules
The qualified name of the element is correct. The title exists and is not empty. A classification is required. At least 1 ownerProducer exists and is non-empty.

Overrides:

validate in class AbstractSimpleString

Throws:

InvalidDDMSException

See Also:

AbstractBaseComponent.validate()

getOutput

public String getOutput(boolean isHTML,
               String prefix,
               String suffix)

Description copied from class: AbstractBaseComponent

Renders this component as HTML or Text, with an optional prefix to nest it.

Specified by:

getOutput in class AbstractBaseComponent

Parameters:

isHTML - true for HTML, false for Text.

prefix - an optional prefix to put on each name.

suffix - an optional suffix to append to each name, such as an index.

Returns:

the HTML or Text representation of this component

See Also:

AbstractBaseComponent.getOutput(boolean, String, String)

equals

public boolean equals(Object obj)

Description copied from class: AbstractBaseComponent

Test for logical equality.

The base case tests against the name value and namespaceURI, as well as any child components classified as "nested components" and any security attributes. Extending classes may require additional rules for equality. This case automatically includes any nested components or security attributes.

Overrides:

equals in class AbstractSimpleString

See Also:

Object.equals(Object)

getName

public static String getName(DDMSVersion version)

Accessor for the element name of this component, based on the version of DDMS used

Parameters:

version - the DDMSVersion

Returns:

an element name