buri.ddmsence.ddms.resource

Class RecordsManagementInfo

Object

buri.ddmsence.AbstractBaseComponent

buri.ddmsence.ddms.resource.RecordsManagementInfo

All Implemented Interfaces:

IDDMSComponent

public final class RecordsManagementInfo
extends AbstractBaseComponent

An immutable implementation of ddms:recordsManagementInfo.

Nested Elements
ddms:recordKeeper: The organization responsible for the custody and ongoing management of the records (0-1 optional), implemented as a RecordKeeper ddms:applicationSoftware: The software used to create the object to which this metadata applies (0-1 optional), implemented as an ApplicationSoftware

Attributes
ddms:vitalRecordIndicator: An indication that a publication is categorized a vital record by the originating agency (defaults to false)

Since:

2.0.0

Author:

Brian Uri!

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
RecordsManagementInfo(nu.xom.Element element) Constructor for creating a component from a XOM Element
RecordsManagementInfo(RecordKeeper recordKeeper, ApplicationSoftware applicationSoftware, Boolean vitalRecordIndicator) 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.
ApplicationSoftware	getApplicationSoftware() Accessor for the applicationSoftware
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.
RecordKeeper	getRecordKeeper() Accessor for the recordKeeper
Boolean	getVitalRecordIndicator() Accessor for the vitalRecordIndicator attribute.
int	hashCode() Returns a hashcode for the component.
protected void	validate() Validates the component.

Methods inherited from class buri.ddmsence.AbstractBaseComponent

addDdms40Warning, addWarning, addWarnings, buildIndex, buildOutput, buildOutput, buildPrefix, getAttributeValue, getAttributeValue, getChild, getChildTextAsDouble, getDDMSVersion, getLocatorSuffix, getName, getNamespace, getPrefix, getQualifiedName, getSecurityAttributes, getStringAsDouble, getValidationWarnings, getXOMElement, getXOMElementCopy, requireVersion, setXOMElement, toHTML, toString, toText, toXML, validateWarnings

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RecordsManagementInfo

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

RecordsManagementInfo

public RecordsManagementInfo(RecordKeeper recordKeeper,
                     ApplicationSoftware applicationSoftware,
                     Boolean vitalRecordIndicator)
                      throws InvalidDDMSException

Constructor for creating a component from raw data

Parameters:

recordKeeper - the record keeper (optional)

applicationSoftware - the software (optional)

vitalRecordIndicator - whether this is a vital record (optional, defaults to false)

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. Only 0-1 record keepers or applicationSoftwares exist. This component cannot exist until DDMS 4.0.1 or later.

Overrides:

validate in class AbstractBaseComponent

Throws:

InvalidDDMSException - if any required information is missing or malformed

See Also:

AbstractBaseComponent.validate()

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

getRecordKeeper

public RecordKeeper getRecordKeeper()

Accessor for the recordKeeper

getApplicationSoftware

public ApplicationSoftware getApplicationSoftware()

Accessor for the applicationSoftware

getVitalRecordIndicator

public Boolean getVitalRecordIndicator()

Accessor for the vitalRecordIndicator attribute. This defaults to false if not found.