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

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

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

History
The network and otherNetwork attributes originated from DDMS 4.x's import of IC-COMMON. IC-COMMON was replaced by VIRT in DDMS 5.0, dropping otherNetwork, and moving network into the virt namespace.

Nested Elements
Name Cardinality Availability ddms:link 0..* In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ddms:details 0..* In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0

Attributes

Name Cardinality Availability ddms:revisionID 1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ddms:revisionType 1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 network 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 virt:network 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 otherNetwork 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ism:classification 1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ism:ownerProducer 1..* 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 ism:<securityAttributes> 0..* In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0

Validation Rules

Rule Type Applicability Component must not be used before the DDMS version in which it was introduced. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 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 A valid component must not have both non-empty child text and nested elements. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 All ddms:links must have security attributes. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 The revisionID must be a valid Integer. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 The revisionType must be a valid type token. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 If set, xlink:type must have a value of "resource". Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 If set, network or virt:network must be a valid network token. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 network and otherNetwork must not be used after the DDMS version in which they were removed. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ism:classification must exist. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ism:ownerProducer must exist. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ism:classification must exist on any ddms:links. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ism:ownerProducer must exist on any ddms:links. 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

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

Fields inherited from class buri.ddmsence.AbstractBaseComponent

OUTPUT_TEMPLATES

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

Modifier and Type	Method and Description
boolean	equals(Object obj) Test for logical equality.
List<Details>	getDetails() Accessor for the list of Details.
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 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.
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 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, 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

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

details - associated details

revisionID - integer ID for this recall

revisionType - type of revision

network - the network

otherNetwork - another network

xlinkAttributes - simple xlink attributes

securityAttributes - security attributes

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

revisionID - integer ID for this recall

revisionType - type of revision

network - the network

otherNetwork - another network

xlinkAttributes - simple xlink attributes

securityAttributes - security attributes

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

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