RelatedResource (DDMSence 2.6.0 API)

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.

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

History
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/JSON/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.

History

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/JSON/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.

Nested Elements

Name

Cardinality

Availability

ddms:link

1..*

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

Attributes

Name

Cardinality

Availability

ddms:relationship

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ddms:direction

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ddms:qualifier

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ddms:value

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ism:<securityAttributes>

0..*

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

Validation Rules

Rule

Type

Applicability

The qualified name of this element must be correct.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ddms:relationship must exist, and must be a valid URI.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

If set, ddms:direction must be a valid token.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ddms:qualifier must exist, and must be a valid URI.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ddms:value must exist.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

At least 1 ddms:link exists.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

Links must not contain security attributes.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

Parent component should not contain more than 1 ddms:relatedResource.

Warning

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

Does NOT validate that the value is valid against the qualifier's vocabulary.

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.

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.AbstractBaseComponent
OUTPUT_TEMPLATES

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

All Methods Static Methods Instance Methods Concrete 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)
`String`	`getHTMLTextOutput(OutputFormat format, String prefix, String suffix)` Renders this component as HTML or Text, with an optional prefix to nest it.
`com.google.gson.JsonObject`	`getJSONObject()` Renders this component as a JSON object, which can either be converted to a JSON string or inserted into the parent JSON object.
`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`	`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()` Base case for validation.
`static void`	`validateRelationshipDirection(String direction)` Asserts that a direction is valid.
`protected void`	`validateWarnings()` Base case for warnings.

Methods inherited from class buri.ddmsence.AbstractQualifierValue
getQualifierName, getValueName

Methods inherited from class buri.ddmsence.AbstractBaseComponent
addDdms40Warning, addJson, addJson, addJson, addJson, addWarning, addWarnings, buildHTMLTextOutput, buildHTMLTextOutput, buildIndex, buildPrefix, getAttributeValue, getAttributeValue, getChild, getChildTextAsDouble, getDDMSVersion, getLocatorSuffix, getName, getNamespace, getPrefix, getQualifiedName, getValidationWarnings, getXOMElement, getXOMElementCopy, requireAtLeastVersion, requireAtMostVersion, setXOMElement, toHTML, toJSON, 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
    
    direction - the relationship direction
    
    qualifier - the value of the qualifier attribute
    
    value - the value of the value attribute
    
    securityAttributes - any security attributes
    
    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
```
    Description copied from class: AbstractBaseComponent
    
    Base case for validation. This method can be overridden for more in-depth validation. It is always assumed that the subcomponents of a component are already valid.
    
    Overrides:
    
    validate in class AbstractBaseComponent
    
    Throws:
    
    InvalidDDMSException
    
    See Also:
    
    AbstractBaseComponent.validate()
  - validateWarnings
```
protected void validateWarnings()
```
    Description copied from class: AbstractBaseComponent
    
    Base case for warnings. This method can be overridden for more in-depth validation. It is always assumed that the subcomponents of a component are already valid.
    
    Overrides:
    
    validateWarnings in class AbstractBaseComponent
    
    See Also:
    
    AbstractBaseComponent.validateWarnings()
  - getJSONObject
```
public com.google.gson.JsonObject getJSONObject()
```
    Description copied from class: AbstractBaseComponent
    
    Renders this component as a JSON object, which can either be converted to a JSON string or inserted into the parent JSON object. Although this method is marked a public, it is only intended to be used internally, and is not part of the IDDMSComponent interface. Use the toJSON() method as the public way to get JSON output.
    
    Specified by:
    
    getJSONObject in class AbstractBaseComponent
    
    See Also:
    
    AbstractBaseComponent.getJSONObject()
  - getHTMLTextOutput
```
public String getHTMLTextOutput(OutputFormat format,
                                String prefix,
                                String suffix)
```
    Description copied from class: AbstractBaseComponent
    
    Renders this component as HTML or Text, with an optional prefix to nest it.
    I consider this to be an internal method, that unfortunately must be marked as public to allow cross-package access when generating output. Use toHTML() and toText() as the formal, public methods to generate output.
    
    Specified by:
    
    getHTMLTextOutput in class AbstractBaseComponent
    
    Parameters:
    
    format - the desired format of this output
    
    prefix - an optional prefix to put on each name.
    
    suffix - an optional suffix to append to each name, such as an index.
    
    Returns:
    
    the representation of this component in the specified format
    
    See Also:
    
    AbstractBaseComponent.getHTMLTextOutput(OutputFormat, 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

Class RelatedResource

Nested Class Summary

Field Summary

Fields inherited from class buri.ddmsence.AbstractBaseComponent

Constructor Summary

Method Summary

Methods inherited from class buri.ddmsence.AbstractQualifierValue

Methods inherited from class buri.ddmsence.AbstractBaseComponent

Methods inherited from class Object

Field Detail

INBOUND_DIRECTION

OUTBOUND_DIRECTION

BIDRECTIONAL_DIRECTION

OLD_INNER_NAME

Constructor Detail

RelatedResource

RelatedResource

Method Detail

validateRelationshipDirection

validate

validateWarnings

getJSONObject

getHTMLTextOutput

getNestedComponents

equals

hashCode

getName

getLinks

getRelationship

getDirection

getQualifier

getValue

getSecurityAttributes