buri.ddmsence.ddms.summary

Class RelatedResource

Object

buri.ddmsence.AbstractBaseComponent

buri.ddmsence.AbstractQualifierValue

buri.ddmsence.ddms.summary.RelatedResource

All Implemented Interfaces:

IDDMSComponent

public final class RelatedResource
extends AbstractQualifierValue

An immutable implementation of the ddms:relatedResource component.

Before DDMS 4.0.1, ddms:RelatedResources was the top-level component (0-many in a resource) and contained 1 to many ddms:relatedResource components. Starting in DDMS 4.0.1, the ddms:RelatedResources component was removed, and the ddms:relatedResource now contains all of the parent information (relationship and direction).

The element-based constructor for this class can automatically handle these cases, and will automatically mediate the Text/HTML/XML output:

• A pre-DDMS 4.0.1 ddms:RelatedResources element containing 1 ddms:relatedResource.
• A post-DDMS 4.0.1 ddms:relatedResource element.

If you have a case where a pre-DDMS 4.0.1 ddms:RelatedResources element contained 5 ddms:relatedResource elements, the Resource class will automatically mediate it to create 5 RelatedResource instances. If an old-fashioned parent element containing multiple children is loaded in the element-based constructor, only the first child will be processed, and a warning will be provided.

Strictness
DDMSence is stricter than the specification in the following ways: A non-empty relationship attribute is required. A non-empty qualifier value is required. A non-empty value attribute is required.

Nested Elements
ddms:link: a link for the resource (1-many required), implemented as a Link

Attributes

ddms:relationship: A URI representing a relationship of some relationship type between the resource being described and other resources. (required) ddms:direction: Used to indicate the direction of the relationship between the resource being described and the target related resource. Valid values are "inbound," "outbound," and "bidirectional". (optional) ddms:qualifier: A URI specifying the formal identification system or encoding scheme by which the identifier value is to be interpreted. (required) ddms:value: an unambiguous reference to the resource within a given context. An internal, external, and/or universal identification number for a data asset or resource. (required) SecurityAttributes: The classification and ownerProducer attributes are optional.

Since:

0.9.b

Author:

Brian Uri!

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	BIDRECTIONAL_DIRECTION The value for an bidirectional direction.
static String	INBOUND_DIRECTION The value for an inbound direction.
static String	OLD_INNER_NAME The pre-DDMS 4.0.1 name of the nested resource elements
static String	OUTBOUND_DIRECTION The value for an outbound direction.

Fields inherited from class buri.ddmsence.AbstractQualifierValue

QUALIFIER_NAME, VALUE_NAME

Constructor Summary

Constructors

Constructor and Description
RelatedResource(nu.xom.Element element) Constructor for creating a component from a XOM Element
RelatedResource(List<Link> links, String relationship, String direction, 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	getDirection() Accessor for the direction attribute (may be empty)
List<Link>	getLinks() Accessor for the links (1 to many).
static String	getName(DDMSVersion version) Accessor for the element name of this component, based on the version of DDMS used
protected List<IDDMSComponent>	getNestedComponents() Accessor for a collection of nested components.
String	getOutput(boolean isHTML, String prefix, String suffix) Renders this component as HTML or Text, with an optional prefix to nest it.
String	getQualifier() Accessor for the value of the qualifier attribute
String	getRelationship() Accessor for the relationship attribute
SecurityAttributes	getSecurityAttributes() Accessor for the Security Attributes.
String	getValue() Accessor for the value of the value attribute
int	hashCode() Returns a hashcode for the component.
protected void	validate() Validates the component.
static void	validateRelationshipDirection(String direction) Asserts that a direction is valid.
protected void	validateWarnings() Validates any conditions that might result in a warning.

Methods inherited from class buri.ddmsence.AbstractBaseComponent

addDdms40Warning, addWarning, addWarnings, buildIndex, buildOutput, buildOutput, buildPrefix, getAttributeValue, getAttributeValue, getChild, getChildTextAsDouble, getDDMSVersion, getLocatorSuffix, getName, getNamespace, 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

Field Detail

INBOUND_DIRECTION

public static final String INBOUND_DIRECTION

The value for an inbound direction.

See Also:

Constant Field Values

OUTBOUND_DIRECTION

public static final String OUTBOUND_DIRECTION

The value for an outbound direction.

See Also:

Constant Field Values

BIDRECTIONAL_DIRECTION

public static final String BIDRECTIONAL_DIRECTION

The value for an bidirectional direction.

See Also:

Constant Field Values

OLD_INNER_NAME

public static final String OLD_INNER_NAME

The pre-DDMS 4.0.1 name of the nested resource elements

See Also:

Constant Field Values

Constructor Detail

RelatedResource

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

RelatedResource

public RelatedResource(List<Link> links,
               String relationship,
               String direction,
               String qualifier,
               String value,
               SecurityAttributes securityAttributes)
                throws InvalidDDMSException

Constructor for creating a component from raw data

Parameters:

links - the xlinks

relationship - the relationship attribute (required)

direction - the relationship direction (optional)

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

validateRelationshipDirection

public static void validateRelationshipDirection(String direction)
                                          throws InvalidDDMSException

Asserts that a direction is valid.

Parameters:

direction - the string to check

Throws:

InvalidDDMSException - if the value is null, empty or invalid.

validate

protected void validate()
                 throws InvalidDDMSException

Validates the component.

Rules
The qualified name of the element is correct. A relationship exists and is not empty. The relationship is a valid URI. If set, the direction has a valid value. A qualifier exists and is not empty. A value exists and is not empty. The qualifier is a valid URI. At least 1 link exists. No link contains security attributes. Does NOT validate that the value is valid against the qualifier's vocabulary.

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
Before DDMS 4.0.1, warn if the parent component contains more than 1 ddms:relatedResource.

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)

getNestedComponents

protected List<IDDMSComponent> getNestedComponents()

Description copied from class: AbstractBaseComponent

Accessor for a collection of nested components. A list such as this is useful for bulk actions, such as checking emptiness, equality, generating hash codes, or applying mass validation.

Overrides:

getNestedComponents in class AbstractBaseComponent

See Also:

AbstractBaseComponent.getNestedComponents()

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

getLinks

public List<Link> getLinks()

Accessor for the links (1 to many).

Returns:

unmodifiable List

getRelationship

public String getRelationship()

Accessor for the relationship attribute

getDirection

public String getDirection()

Accessor for the direction attribute (may be empty)

getQualifier

public String getQualifier()

Accessor for the value of the qualifier attribute

Overrides:

getQualifier in class AbstractQualifierValue

getValue

public String getValue()

Accessor for the value of the value attribute

Overrides:

getValue in class AbstractQualifierValue

getSecurityAttributes

public SecurityAttributes getSecurityAttributes()

Accessor for the Security Attributes. Will always be non-null even if the attributes are not set.

Specified by:

getSecurityAttributes in interface IDDMSComponent

Overrides:

getSecurityAttributes in class AbstractBaseComponent