buri.ddmsence.ddms.resource

Class RevisionRecall

Object

buri.ddmsence.AbstractBaseComponent

buri.ddmsence.ddms.resource.RevisionRecall

All Implemented Interfaces:

IDDMSComponent

public final class RevisionRecall
extends AbstractBaseComponent

An immutable implementation of ddms:revisionRecall.

A revisionRecall element will either contain free child text describing the recall, or a set of link and details elements.

Strictness
DDMSence is stricter than the specification in the following ways: A valid component cannot have both non-empty child text and nested elements.

Nested Elements
ddms:link: Links to further information about the recall (0-many optional), implemented as a Link ddms:details: Further details about the recall (0-many optional), implemented as a Details

Attributes

ddms:revisionID: a sequential integer for the recall (required) ddms:revisionType: an enumerated type for the recall (required) network: the name of the network, taken from a token list (optional) otherNetwork: an alternate network name (optional) XLinkAttributes: If set, the xlink:type attribute must have a fixed value of "resource". SecurityAttributes: The classification and ownerProducer attributes are required.

Since:

2.0.0

Author:

Brian Uri!

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	NO_NAMESPACE The namespace of the network attributes
static String	NO_PREFIX The prefix of the network attributes

Constructor Summary

Constructors

Constructor and Description
RevisionRecall(nu.xom.Element element) Constructor for creating a component from a XOM Element
RevisionRecall(List<Link> links, List<Details> details, Integer revisionID, String revisionType, String network, String otherNetwork, XLinkAttributes xlinkAttributes, SecurityAttributes securityAttributes) Constructor for creating a component from raw data, based on links and details.
RevisionRecall(String value, Integer revisionID, String revisionType, String network, String otherNetwork, XLinkAttributes xlinkAttributes, SecurityAttributes securityAttributes) Constructor for creating a component from raw data, based on child text.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Test for logical equality.
List<Details>	getDetails() Accessor for the list of Details.
List<Link>	getLinks() Accessor for the list of Links.
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	getNetwork() Accessor for the network attribute.
String	getOtherNetwork() Accessor for the otherNetwork attribute.
String	getOutput(boolean isHTML, String prefix, String suffix) Renders this component as HTML or Text, with an optional prefix to nest it.
Integer	getRevisionID() Accessor for the revisionID attribute.
String	getRevisionType() Accessor for the revisionType attribute.
SecurityAttributes	getSecurityAttributes() Accessor for the Security Attributes.
String	getValue() Accessor for the value of the child text.
XLinkAttributes	getXLinkAttributes() Accessor for the XDetails 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.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

NO_PREFIX

public static final String NO_PREFIX

The prefix of the network attributes

See Also:

Constant Field Values

NO_NAMESPACE

public static final String NO_NAMESPACE

The namespace of the network attributes

See Also:

Constant Field Values

Constructor Detail

RevisionRecall

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

RevisionRecall

public RevisionRecall(List<Link> links,
              List<Details> details,
              Integer revisionID,
              String revisionType,
              String network,
              String otherNetwork,
              XLinkAttributes xlinkAttributes,
              SecurityAttributes securityAttributes)
               throws InvalidDDMSException

Constructor for creating a component from raw data, based on links and details.

Parameters:

links - associated links (optional)

details - associated details (optional)

revisionID - integer ID for this recall (required)

revisionType - type of revision (required)

network - the network (optional)

otherNetwork - another network (optional)

xlinkAttributes - simple xlink attributes (optional)

securityAttributes - security attributes (required)

Throws:

InvalidDDMSException - if any required information is missing or malformed

RevisionRecall

public RevisionRecall(String value,
              Integer revisionID,
              String revisionType,
              String network,
              String otherNetwork,
              XLinkAttributes xlinkAttributes,
              SecurityAttributes securityAttributes)
               throws InvalidDDMSException

Constructor for creating a component from raw data, based on child text.

Parameters:

value - the child text describing this revision (required)

revisionID - integer ID for this recall (required)

revisionType - type of revision (required)

network - the network (optional)

otherNetwork - another network (optional)

xlinkAttributes - simple xlink attributes (optional)

securityAttributes - security attributes (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. A valid component cannot have both non-empty child text and nested elements. Any links should have security attributes. The revisionID must be a valid Integer. The revisionType must be a valid type token. If set, the xlink:type attribute has a value of "resource". If set, the network attribute must be a valid network token.

Overrides:

validate in class AbstractBaseComponent

Throws:

InvalidDDMSException

See Also:

AbstractBaseComponent.validate()

validateWarnings

protected void validateWarnings()

Validates any conditions that might result in a warning.

Rules
Include any warnings from the XLink attributes.

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 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

getLinks

public List<Link> getLinks()

Accessor for the list of Links.

getDetails

public List<Details> getDetails()

Accessor for the list of Details.

getValue

public String getValue()

Accessor for the value of the child text.

getRevisionID

public Integer getRevisionID()

Accessor for the revisionID attribute.

getRevisionType

public String getRevisionType()

Accessor for the revisionType attribute.

getNetwork

public String getNetwork()

Accessor for the network attribute.

getOtherNetwork

public String getOtherNetwork()

Accessor for the otherNetwork attribute.

getXLinkAttributes

public XLinkAttributes getXLinkAttributes()

Accessor for the XDetails 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