buri.ddmsence.ddms.resource

Class Type

Object

buri.ddmsence.AbstractBaseComponent

buri.ddmsence.AbstractQualifierValue

buri.ddmsence.ddms.resource.Type

All Implemented Interfaces:

IDDMSComponent

public final class Type
extends AbstractQualifierValue

An immutable implementation of ddms:type.

Beginning in DDMS 4.0.1, a ddms:type element can contain child text. The intent of this text is to provide further context when the ddms:type element references an IC activity.

Strictness
DDMSence is stricter than the specification in the following ways: A non-empty qualifier value is required when the value attribute is set. DDMSence allows the following legal, but nonsensical constructs: A qualifier can be set with no value. A type can be set without a qualifier or value.

Attributes
ddms:qualifier: a URI-based qualifier (required if value is set) ddms:value: includes terms describing general categories, functions, genres, or aggregation levels (optional) SecurityAttributes: The classification and ownerProducer attributes are optional. (starting in DDMS 4.0.1)

Since:

0.9.b

Author:

Brian Uri!

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class buri.ddmsence.AbstractQualifierValue

QUALIFIER_NAME, VALUE_NAME

Constructor Summary

Constructors

Constructor and Description
Type(nu.xom.Element element) Constructor for creating a component from a XOM Element
Type(String description, String qualifier, String value, 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.
String	getDescription() Accessor for the description child text, which provides additional context to the qualifier/value pairing of this component.
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.
SecurityAttributes	getSecurityAttributes() Accessor for the Security Attributes.
int	hashCode() Returns a hashcode for the component.
protected void	validate() Validates the component.
protected void	validateWarnings() Validates any conditions that might result in a warning.

Methods inherited from class buri.ddmsence.AbstractQualifierValue

getQualifier, getValue

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

Methods inherited from class Object

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

Constructor Detail

Type

public Type(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

Type

public Type(String description,
    String qualifier,
    String value,
    SecurityAttributes securityAttributes)
     throws InvalidDDMSException

Constructor for creating a component from raw data

Parameters:

description - the child text describing an IC activity, if this component is used to reference an IC activity

qualifier - the value of the qualifier attribute

value - the value of the value attribute

securityAttributes - any security attributes (optional)

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 description child text cannot exist until DDMS 4.0.1 or later. If a value is set, a qualifier must exist and be non-empty. Does NOT validate that the value is valid against the qualifier's vocabulary. The SecurityAttributes do not exist until DDMS 4.0.1 or later.

Overrides:

validate in class AbstractBaseComponent

Throws:

InvalidDDMSException - if any required information is missing or malformed

See Also:

AbstractBaseComponent.validate()

validateWarnings

protected void validateWarnings()

Validates any conditions that might result in a warning.

Rules
A qualifier has been set without an accompanying value attribute. Neither a qualifier nor a value was set on this type.

Overrides:

validateWarnings in class AbstractBaseComponent

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 AbstractQualifierValue

See Also:

Object.equals(Object)

hashCode

public int hashCode()

Description copied from class: AbstractBaseComponent

Returns a hashcode for the component.

This automatically includes any nested components or security attributes.

Overrides:

hashCode in class AbstractQualifierValue

See Also:

Object.hashCode()

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

getDescription

public String getDescription()

Accessor for the description child text, which provides additional context to the qualifier/value pairing of this component. The underlying XOM method which retrieves the child text returns an empty string if not found.

getSecurityAttributes

public SecurityAttributes getSecurityAttributes()

Accessor for the Security Attributes. Will always be non-null, even if it has no values set.

Specified by:

getSecurityAttributes in interface IDDMSComponent

Overrides:

getSecurityAttributes in class AbstractBaseComponent