Link (DDMSence 2.2.0 API)

Object
- buri.ddmsence.AbstractBaseComponent
- - buri.ddmsence.ddms.summary.Link

All Implemented Interfaces:: IDDMSComponent

public final class Link
extends AbstractBaseComponent

An immutable implementation of ddms:link.

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

History
None.

Nested Elements

Name

Cardinality

Availability

None.

Attributes

Name

Cardinality

Availability

ism:classification

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ism:ownerProducer

0..*

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

xlink:<xlinkAttributes>

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

xlink:type must exist, and must be set to "locator".

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

xlink:href must exist.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

Security attributes must not be used before the DDMS version in which they were introduced.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

Warnings from any XLink attributes are claimed by this component.

Warning

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

When a Link is used by RelatedResource, it cannot have security attributes. When a Link is used by RevisionRecall, it must have security attributes. This is validated in the parent class.

Since:: 0.9.b
Author:: Brian Uri!

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Link.Builder
Builder for this DDMS component.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Link.Builder` Builder for this DDMS component.

Constructor Summary

Constructors
Constructor and Description
`Link(nu.xom.Element element)` Constructor for creating a component from a XOM Element
`Link(XLinkAttributes xlinkAttributes)` Constructor for creating a component from raw data
`Link(XLinkAttributes xlinkAttributes, 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.
`SecurityAttributes`	`getSecurityAttributes()` Accessor for the Security Attributes.
`XLinkAttributes`	`getXLinkAttributes()` Accessor for the XLink Attributes.
`int`	`hashCode()` Returns a hashcode for the component.
`protected void`	`validate()` Base case for validation.
`protected void`	`validateWarnings()` Base case for warnings.

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, getValidationWarnings, getXOMElement, getXOMElementCopy, requireAtLeastVersion, requireAtMostVersion, setXOMElement, toHTML, toString, toText, toXML

Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Link
```
public Link(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
  - Link
```
public Link(XLinkAttributes xlinkAttributes)
     throws InvalidDDMSException
```
    Constructor for creating a component from raw data
    
    Parameters:
    xlinkAttributes - the xlink attributes
    
    Throws:
    
    InvalidDDMSException - if any required information is missing or malformed
  - Link
```
public Link(XLinkAttributes xlinkAttributes,
    SecurityAttributes securityAttributes)
     throws InvalidDDMSException
```
    Constructor for creating a component from raw data
    
    Parameters:
    xlinkAttributes - the xlink attributes
    securityAttributes - attributes, which are only allowed on links within a ddms:revisionRecall
    
    Throws:
    
    InvalidDDMSException - if any required information is missing or malformed
- Method Detail
  - 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()
  - 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 AbstractBaseComponent
    
    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 AbstractBaseComponent
    
    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
  - getXLinkAttributes
```
public XLinkAttributes getXLinkAttributes()
```
    Accessor for the XLink Attributes. Will always be non-null, even if it has no values set.
  - 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

Class Link

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class buri.ddmsence.AbstractBaseComponent

Methods inherited from class Object

Constructor Detail

Link

Link

Link

Method Detail

validate

validateWarnings

getOutput

equals

hashCode

getName

getXLinkAttributes

getSecurityAttributes