buri.ddmsence.ddms.summary

Class SubjectCoverage

Object

buri.ddmsence.AbstractBaseComponent

buri.ddmsence.ddms.summary.SubjectCoverage

All Implemented Interfaces:

IDDMSComponent

public final class SubjectCoverage
extends AbstractBaseComponent

An immutable implementation of ddms:subjectCoverage.

Before DDMS 4.0.1, a subjectCoverage element contains a locally defined Subject construct. This construct is a container for the keywords and categories of a resource. It exists only inside of a ddms:subjectCoverage parent, so it is not implemented as a Java object. Starting in DDMS 4.0.1, the Subject wrapper has been removed.

Strictness
DDMSence allows the following legal, but nonsensical constructs: Duplicate keywords or categories can be used.

Nested Elements

ddms:category: a category (0-many optional), implemented as a Category ddms:keyword: a keyword (0-many optional), implemented as a Keyword ddms:productionMetric: a categorization scheme whose values and use are defined by DDNI-A. (0-many optional, starting in DDMS 4.0.1), implemented as a ProductionMetric ddms:nonStateActor: a non-state actor within the scope of this coverage (0-many optional, starting in DDMS 4.0.1), implemented as a NonStateActor At least 1 of category or keyword must be used.

Attributes
SecurityAttributes: The classification and ownerProducer attributes are optional. (starting in DDMS 3.0)

Since:

0.9.b

Author:

Brian Uri!

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
SubjectCoverage(nu.xom.Element element) Constructor for creating a component from a XOM Element
SubjectCoverage(List<Keyword> keywords, List<Category> categories, List<ProductionMetric> productionMetrics, List<NonStateActor> nonStateActors, 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.
List<Category>	getCategories() Accessor for the categories (0 to many).
List<Keyword>	getKeywords() Accessor for the keywords (0 to many).
protected String	getLocatorSuffix() Can be overridden to change the locator string used in warnings and errors.
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.
List<NonStateActor>	getNonStateActors() Accessor for the non-state actors (0 to many).
String	getOutput(boolean isHTML, String prefix, String suffix) Renders this component as HTML or Text, with an optional prefix to nest it.
List<ProductionMetric>	getProductionMetrics() Accessor for the production metrics (0 to many).
SecurityAttributes	getSecurityAttributes() Accessor for the Security Attributes.
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, getName, getNamespace, getPrefix, getQualifiedName, getStringAsDouble, getValidationWarnings, getXOMElement, getXOMElementCopy, hashCode, requireVersion, setXOMElement, toHTML, toString, toText, toXML

Methods inherited from class Object

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

Constructor Detail

SubjectCoverage

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

SubjectCoverage

public SubjectCoverage(List<Keyword> keywords,
               List<Category> categories,
               List<ProductionMetric> productionMetrics,
               List<NonStateActor> nonStateActors,
               SecurityAttributes securityAttributes)
                throws InvalidDDMSException

Constructor for creating a component from raw data

Parameters:

keywords - list of keywords

categories - list of categories

productionMetrics - list of metrics

nonStateActors - list of actors

securityAttributes - any security attributes (optional)

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. At least 1 of "Keyword" or "Category" must exist. The SecurityAttributes do not exist until DDMS 3.0 or later.

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
1 or more keywords have the same value. 1 or more categories have the same value. 1 or more productionMetrics have the same value.

Overrides:

validateWarnings in class AbstractBaseComponent

getLocatorSuffix

protected String getLocatorSuffix()

Description copied from class: AbstractBaseComponent

Can be overridden to change the locator string used in warnings and errors.

For components such as Format, there are wrapper elements that are not implemented as Java objects. These elements should be included in the XPath string used to identify the source of the error.

For example, if a ddms:extent element has a warning and the ddms:format element reports it, the locator information should be "/ddms:format/ddms:Media/ddms:extent" and not the default of "/ddms:format/ddms:extent"

Overrides:

getLocatorSuffix in class AbstractBaseComponent

Returns:

an empty string, unless overridden.

See Also:

AbstractBaseComponent.getLocatorSuffix()

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)

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

getKeywords

public List<Keyword> getKeywords()

Accessor for the keywords (0 to many).

Returns:

unmodifiable List

getCategories

public List<Category> getCategories()

Accessor for the categories (0 to many).

Returns:

unmodifiable List

getProductionMetrics

public List<ProductionMetric> getProductionMetrics()

Accessor for the production metrics (0 to many).

Returns:

unmodifiable List

getNonStateActors

public List<NonStateActor> getNonStateActors()

Accessor for the non-state actors (0 to many).

Returns:

unmodifiable List

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