buri.ddmsence.ddms

Class Resource

Object

buri.ddmsence.AbstractBaseComponent

buri.ddmsence.ddms.Resource

All Implemented Interfaces:

IDDMSComponent

public final class Resource
extends AbstractBaseComponent

An immutable implementation of ddms:resource (the top-level element of a DDMS record).

Starting in DDMS 3.0, resources have additional ISM attributes which did not exist in 2.0. However, the 2.0 schema still allows "any" attributes on the Resource, so the 3.0 attribute values will be loaded if present.

When generating HTML/Text output for a Resource, additional tags are generated listing the version of DDMSence used to create the record (to help identify formatting bugs), and the version of DDMS. These lines are not required (and may be removed). For example:

ddms.generator: DDMSence 1.0.0
ddms.version: 3.0

<meta name="ddms.generator" content="DDMSence 1.0.0" />
<meta name="ddms.version" content="3.0" />


The name of this component was changed from "Resource" to "resource" in DDMS 4.0.1.

Nested Elements

ddms:metacardInfo: (exactly 1 required, starting in DDMS 4.0.1), implemented as a MetacardInfo ddms:identifier: (1-many required), implemented as an Identifier ddms:title: (1-many required), implemented as a Title ddms:subtitle: (0-many optional), implemented as a Subtitle ddms:description: (0-1 optional), implemented as a Description ddms:language: (0-many optional), implemented as a Language ddms:dates: (0-1 optional), implemented as a Dates ddms:rights: (0-1 optional), implemented as a Rights ddms:source: (0-many optional), implemented as a Source ddms:type: (0-many optional), implemented as a Type ddms:contributor: (0-many optional), implemented as a Contributor ddms:creator: (0-many optional), implemented as a Creator ddms:pointOfContact: (0-many optional), implemented as a PointOfContact ddms:publisher: (0-many optional), implemented as a Publisher ddms:format: (0-1 optional), implemented as a Format ddms:subjectCoverage: (1-many required, starting in DDMS 4.0.1), implemented as a SubjectCoverage ddms:virtualCoverage: (0-many optional), implemented as a VirtualCoverage ddms:temporalCoverage: (0-many optional), implemented as a TemporalCoverage ddms:geospatialCoverage: (0-many optional), implemented as a GeospatialCoverage ddms:relatedResource: (0-many optional), implemented as a RelatedResource ddms:resourceManagement: (0-1 optional, starting in DDMS 4.0.1), implemented as a ResourceManagement ddms:security: (exactly 1 required), implemented as a Security Extensible Layer: (0-many optional), implemented as a ExtensibleElement

Attributes

ISM:resourceElement: Identifies whether this tag sets the classification for the xml file as a whole (required, starting in DDMS 3.0) ISM:createDate: Specifies the creation or latest modification date (YYYY-MM-DD) (required, starting in DDMS 3.0) ISM:DESVersion: Specifies the version of the Data Encoding Specification used for the security markings on this record. (required, starting in DDMS 3.0) ntk:DESVersion: Specifies the version of the Data Encoding Specification used for Need-To-Know markings on this record. (required, starting in DDMS 4.0.1 with a fixed value) SecurityAttributes: The classification and ownerProducer attributes are required. (starting in DDMS 3.0) NoticeAttributes: (optional, starting in DDMS 4.0.1) ExtensibleAttributes: (optional) Starting in DDMS 3.0, the ISM attributes explicitly defined in the schema should appear in the SecurityAttributes, not the ExtensibleAttributes. Attempts to load them as ExtensibleAttributes will throw an InvalidDDMSException. In DDMS 2.0, there are no ISM attributes explicitly defined in the schema, so you can load them in any way you want. It is recommended that you load them as SecurityAttributes anyhow, for consistency with newer DDMS resources. Please see the "Power Tips" on the Extensible Layer (on the DDMSence home page) for details.

Since:

0.9.b

Author:

Brian Uri!

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPLIES_WITH_NAME The attribute name for the compliesWith attribute
protected static String	CREATE_DATE_NAME The attribute name for create date
static String	DES_VERSION_NAME The attribute name for DES version
static Set<String>	NON_EXTENSIBLE_NAMES A set of all Resource attribute names which should not be converted into ExtensibleAttributes
protected static String	RESOURCE_ELEMENT_NAME The attribute name for resource element flag

Constructor Summary

Constructors

Constructor and Description
Resource(nu.xom.Element element) Constructor for creating a component from a XOM Element
Resource(List<IDDMSComponent> topLevelComponents, Boolean resourceElement, String createDate, Integer ismDESVersion, SecurityAttributes securityAttributes, ExtensibleAttributes extensibleAttributes) Constructor for creating a DDMS 3.0 Resource from raw data.
Resource(List<IDDMSComponent> topLevelComponents, Boolean resourceElement, String createDate, List<String> compliesWiths, Integer ismDESVersion, Integer ntkDESVersion, SecurityAttributes securityAttributes, NoticeAttributes noticeAttributes, ExtensibleAttributes extensibleAttributes) Constructor for creating a DDMS resource of any version from raw data.
Resource(List<IDDMSComponent> topLevelComponents, Boolean resourceElement, String createDate, List<String> compliesWiths, Integer ismDESVersion, SecurityAttributes securityAttributes, ExtensibleAttributes extensibleAttributes) Constructor for creating a DDMS 3.1 Resource from raw data.
Resource(List<IDDMSComponent> topLevelComponents, ExtensibleAttributes extensibleAttributes) Constructor for creating a DDMS 2.0 Resource from raw data.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Test for logical equality.
List<String>	getCompliesWiths() Accessor for the ISM compliesWith attribute.
List<Contributor>	getContributors() Accessor for a list of all Contributor entities (0-many)
javax.xml.datatype.XMLGregorianCalendar	getCreateDate() Accessor for the createDate date (optional).
List<Creator>	getCreators() Accessor for a list of all Creator entities (0-many)
Dates	getDates() Accessor for the dates component (0-1).
Description	getDescription() Accessor for the description component (0-1)
ExtensibleAttributes	getExtensibleAttributes() Accessor for the extensible attributes.
List<ExtensibleElement>	getExtensibleElements() Accessor for the extensible layer elements (0-many in 3.0, 0-1 in 2.0).
Format	getFormat() Accessor for the Format component (0-1).
List<GeospatialCoverage>	getGeospatialCoverages() Accessor for the geospatialCoverage components (0-many)
List<Identifier>	getIdentifiers() Accessor for the identifier components.
Integer	getIsmDESVersion() Accessor for the ISM DESVersion attribute.
List<Language>	getLanguages() Accessor for the language components (0-many)
MetacardInfo	getMetacardInfo() Accessor for the MetacardInfo component (exactly 1)
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.
NoticeAttributes	getNoticeAttributes() Accessor for the Notice Attributes.
Integer	getNtkDESVersion() Accessor for the NTK DESVersion attribute.
String	getOutput(boolean isHTML, String prefix, String suffix) Renders this component as HTML or Text, with an optional prefix to nest it.
List<PointOfContact>	getPointOfContacts() Accessor for a list of all PointOfContact entities (0-many)
List<Publisher>	getPublishers() Accessor for a list of all Publisher entities (0-many)
List<RelatedResource>	getRelatedResources() Accessor for the RelatedResource components (0-many)
ResourceManagement	getResourceManagement() Accessor for the ResourceManagement component (0-1).
Rights	getRights() Accessor for the rights component (0-1).
Security	getSecurity() Accessor for the security component (exactly 1).
SecurityAttributes	getSecurityAttributes() Accessor for the Security Attributes.
List<Source>	getSources() Accessor for the source components (0-many)
List<SubjectCoverage>	getSubjectCoverages() Accessor for the subjectCoverage component (1-many)
List<Subtitle>	getSubtitles() Accessor for the subtitle components (0-many)
List<TemporalCoverage>	getTemporalCoverages() Accessor for the temporalCoverage components (0-many)
List<Title>	getTitles() Accessor for the title components.
List<IDDMSComponent>	getTopLevelComponents() Accessor for an ordered list of the components in this Resource.
List<Type>	getTypes() Accessor for the type components (0-many)
List<VirtualCoverage>	getVirtualCoverages() Accessor for the virtualCoverage components (0-many)
int	hashCode() Returns a hashcode for the component.
Boolean	isResourceElement() Accessor for the resourceElement attribute.
protected void	validate() Validates the component.
protected void	validateWarnings() Validates any conditions that might result in a warning.
List<ValidationMessage>	validateWithSchematron(File schematronFile) Performs a Schematron validation of the DDMS Resource, via the ISO Schematron skeleton stylesheets for XSLT1 or XSLT2 processors.

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

RESOURCE_ELEMENT_NAME

protected static final String RESOURCE_ELEMENT_NAME

The attribute name for resource element flag

See Also:

Constant Field Values

CREATE_DATE_NAME

protected static final String CREATE_DATE_NAME

The attribute name for create date

See Also:

Constant Field Values

COMPLIES_WITH_NAME

public static final String COMPLIES_WITH_NAME

The attribute name for the compliesWith attribute

See Also:

Constant Field Values

DES_VERSION_NAME

public static final String DES_VERSION_NAME

The attribute name for DES version

See Also:

Constant Field Values

NON_EXTENSIBLE_NAMES

public static final Set<String> NON_EXTENSIBLE_NAMES

A set of all Resource attribute names which should not be converted into ExtensibleAttributes

Constructor Detail

Resource

public Resource(nu.xom.Element element)
         throws InvalidDDMSException

Constructor for creating a component from a XOM Element

Starting in DDMS 3.0, resources have additional ISM attributes which did not exist in 2.0. However, the 2.0 schema still allows "any" attributes on the Resource, so the 3.0 attribute values will be loaded if present.

Parameters:

element - the XOM element representing this

Throws:

InvalidDDMSException - if any required information is missing or malformed

Resource

public Resource(List<IDDMSComponent> topLevelComponents,
        ExtensibleAttributes extensibleAttributes)
         throws InvalidDDMSException

Constructor for creating a DDMS 2.0 Resource from raw data.

This helper constructor merely calls the fully-parameterized version. Attempts to use it with DDMS 3.0 (or higher) components will fail, because some required attributes are missing.

Parameters:

topLevelComponents - a list of top level components

extensibleAttributes - any extensible attributes (optional)

Throws:

InvalidDDMSException

Resource

public Resource(List<IDDMSComponent> topLevelComponents,
        Boolean resourceElement,
        String createDate,
        Integer ismDESVersion,
        SecurityAttributes securityAttributes,
        ExtensibleAttributes extensibleAttributes)
         throws InvalidDDMSException

Constructor for creating a DDMS 3.0 Resource from raw data.

This helper constructor merely calls the fully-parameterized version. Attempts to use it with DDMS 3.1 (or higher) components will fail, because some required attributes are missing.

Parameters:

topLevelComponents - a list of top level components

resourceElement - value of the resourceElement attribute (required, starting in DDMS 3.0)

createDate - the create date as an xs:date (YYYY-MM-DD) (required, starting in DDMS 3.0)

ismDESVersion - the DES Version as an Integer (required, starting in DDMS 3.0)

securityAttributes - any security attributes (classification and ownerProducer are required, starting in DDMS 3.0)

extensibleAttributes - any extensible attributes (optional)

Throws:

InvalidDDMSException - if any required information is missing or malformed, or if one of the components does not belong at the top-level of the Resource.

Resource

public Resource(List<IDDMSComponent> topLevelComponents,
        Boolean resourceElement,
        String createDate,
        List<String> compliesWiths,
        Integer ismDESVersion,
        SecurityAttributes securityAttributes,
        ExtensibleAttributes extensibleAttributes)
         throws InvalidDDMSException

Constructor for creating a DDMS 3.1 Resource from raw data.

This helper constructor merely calls the fully-parameterized version. Attempts to use it with DDMS 4.0.1 (or higher) components will fail, because some required attributes are missing.

Parameters:

topLevelComponents - a list of top level components

resourceElement - value of the resourceElement attribute (required, starting in DDMS 3.0)

createDate - the create date as an xs:date (YYYY-MM-DD) (required, starting in DDMS 3.0)

compliesWiths - shows what ISM rulesets this resource complies with (optional, starting in DDMS 3.1)

ismDESVersion - the DES Version as an Integer (required, starting in DDMS 3.0)

securityAttributes - any security attributes (classification and ownerProducer are required, starting in DDMS 3.0)

extensibleAttributes - any extensible attributes (optional)

Throws:

InvalidDDMSException - if any required information is missing or malformed, or if one of the components does not belong at the top-level of the Resource.

Resource

public Resource(List<IDDMSComponent> topLevelComponents,
        Boolean resourceElement,
        String createDate,
        List<String> compliesWiths,
        Integer ismDESVersion,
        Integer ntkDESVersion,
        SecurityAttributes securityAttributes,
        NoticeAttributes noticeAttributes,
        ExtensibleAttributes extensibleAttributes)
         throws InvalidDDMSException

Constructor for creating a DDMS resource of any version from raw data.

The other data-driven constructors call this one.

Passing the top-level components in as a list is a compromise between a constructor with over twenty parameters, and the added complexity of a step-by-step factory/builder approach. If any component is not a top-level component, an InvalidDDMSException will be thrown.

The order of different types of components does not matter here (a security component could be the first component in the list). However, if multiple instances of the same component type exist in the list (such as multiple identifier components), those components will be stored and output in the order of the list. If only 1 instance can be supported, the last one in the list will be the one used.

Starting in DDMS 3.0, resources have additional ISM attributes which did not exist in 2.0. However, the 2.0 schema still allows "any" attributes on the Resource, so the attribute values will be loaded if present.

Parameters:

topLevelComponents - a list of top level components

resourceElement - value of the resourceElement attribute (required, starting in DDMS 3.0)

createDate - the create date as an xs:date (YYYY-MM-DD) (required, starting in DDMS 3.0)

compliesWiths - shows what ISM rule sets this resource complies with (optional, starting in DDMS 3.1)

ismDESVersion - the DES Version as an Integer (required, starting in DDMS 3.0)

ntkDESVersion - the DES Version as an Integer (required, starting in DDMS 4.0.1)

securityAttributes - any security attributes (classification and ownerProducer are required, starting in DDMS 3.0)

noticeAttributes - any notice attributes (optional, starting in DDMS 4.0.1)

extensibleAttributes - any extensible attributes (optional)

Throws:

InvalidDDMSException - if any required information is missing or malformed, or if one of the components does not belong at the top-level of the Resource.

Method Detail

validateWithSchematron

public List<ValidationMessage> validateWithSchematron(File schematronFile)
                                               throws nu.xom.xslt.XSLException,
                                                      IOException

Performs a Schematron validation of the DDMS Resource, via the ISO Schematron skeleton stylesheets for XSLT1 or XSLT2 processors. This action can only be performed on a DDMS Resource which is already valid according to the DDMS specification.

The informational results of this validation are returned to the caller in a list of ValidationMessages of type "Warning" for reports and "Error" for failed asserts. These messages do NOT affect the validity of the underlying object model. The locator on the ValidationMessage will be the location attribute from the successful-report or failed-assert element.

Details about ISO Schematron can be found at: http://www.schematron.com/

Parameters:

schematronFile - the file containing the ISO Schematron constraints. This file is transformed with the ISO Schematron skeleton files.

Returns:

a list of ValidationMessages

Throws:

nu.xom.xslt.XSLException - if there are XSL problems transforming with stylesheets

IOException - if there are problems reading or parsing the Schematron file

validate

protected void validate()
                 throws InvalidDDMSException

Validates the component.

Rules

The qualified name of the element is correct. Exactly 1 metacardInfo, 1-many identifiers, 1-many titles, 0-1 descriptions, 0-1 dates, 0-1 rights, 0-1 formats, exactly 1 subjectCoverage, 0-1 resourceManagement, and exactly 1 security element must exist. Starting in DDMS 4.0.1, 1-many subjectCoverage elements can exist. At least 1 of creator, publisher, contributor, or pointOfContact must exist. All ddms:order attributes make a complete, consecutive set, starting at 1. resourceElement attribute must exist, starting in DDMS 3.0. createDate attribute must exist and conform to the xs:date date type (YYYY-MM-DD), starting in DDMS 3.0. The compliesWith attribute cannot be used until DDMS 3.1 or later. If set, the compliesWith attribute must be valid tokens. ISM DESVersion must exist and be a valid Integer, starting in DDMS 3.0. The value of ISM DESVersion must be fixed, starting in DDMS 3.1. This is checked during schema validation. NTK DESVersion must exist and be a valid Integer, starting in DDMS 4.0.1. The value of NTK DESVersion must be fixed,s tarting in DDMS 4.0.1. This is checked during schema validation. A classification is required, starting in DDMS 3.0. At least 1 ownerProducer exists and is non-empty, starting in DDMS 3.0. Only 1 extensible element can exist in DDMS 2.0.

Overrides:

validate in class AbstractBaseComponent

Throws:

InvalidDDMSException - if any required information is missing or malformed

See Also:

AbstractBaseComponent.validate()

validateWarnings

protected void validateWarnings()

Validates any conditions that might result in a warning.

Rules
An externalNotice attribute may cause issues for DDMS 4.0 records. Add any warnings from the notice 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)

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

getMetacardInfo

public MetacardInfo getMetacardInfo()

Accessor for the MetacardInfo component (exactly 1)

getIdentifiers

public List<Identifier> getIdentifiers()

Accessor for the identifier components. There will always be at least one.

getTitles

public List<Title> getTitles()

Accessor for the title components. There will always be at least one.

getSubtitles

public List<Subtitle> getSubtitles()

Accessor for the subtitle components (0-many)

getDescription

public Description getDescription()

Accessor for the description component (0-1)

getLanguages

public List<Language> getLanguages()

Accessor for the language components (0-many)

getDates

public Dates getDates()

Accessor for the dates component (0-1). May return null.

getRights

public Rights getRights()

Accessor for the rights component (0-1). May return null.

getSources

public List<Source> getSources()

Accessor for the source components (0-many)

getTypes

public List<Type> getTypes()

Accessor for the type components (0-many)

getCreators

public List<Creator> getCreators()

Accessor for a list of all Creator entities (0-many)

getPublishers

public List<Publisher> getPublishers()

Accessor for a list of all Publisher entities (0-many)

getContributors

public List<Contributor> getContributors()

Accessor for a list of all Contributor entities (0-many)

getPointOfContacts

public List<PointOfContact> getPointOfContacts()

Accessor for a list of all PointOfContact entities (0-many)

getFormat

public Format getFormat()

Accessor for the Format component (0-1). May return null.

getSubjectCoverages

public List<SubjectCoverage> getSubjectCoverages()

Accessor for the subjectCoverage component (1-many)

getVirtualCoverages

public List<VirtualCoverage> getVirtualCoverages()

Accessor for the virtualCoverage components (0-many)

getTemporalCoverages

public List<TemporalCoverage> getTemporalCoverages()

Accessor for the temporalCoverage components (0-many)

getGeospatialCoverages

public List<GeospatialCoverage> getGeospatialCoverages()

Accessor for the geospatialCoverage components (0-many)

getRelatedResources

public List<RelatedResource> getRelatedResources()

Accessor for the RelatedResource components (0-many)

getResourceManagement

public ResourceManagement getResourceManagement()

Accessor for the ResourceManagement component (0-1). May return null.

getSecurity

public Security getSecurity()

Accessor for the security component (exactly 1). May return null but this cannot happen after instantiation.

getExtensibleElements

public List<ExtensibleElement> getExtensibleElements()

Accessor for the extensible layer elements (0-many in 3.0, 0-1 in 2.0).

isResourceElement

public Boolean isResourceElement()

Accessor for the resourceElement attribute. This may be null for v2.0 Resource components.

getCreateDate

public javax.xml.datatype.XMLGregorianCalendar getCreateDate()

Accessor for the createDate date (optional). Returns a copy. This may be null for v2.0 Resource components.

getCompliesWiths

public List<String> getCompliesWiths()

Accessor for the ISM compliesWith attribute.

getIsmDESVersion

public Integer getIsmDESVersion()

Accessor for the ISM DESVersion attribute. Because this attribute does not exist before DDMS 3.0, the accessor will return null for v2.0 Resource elements.

getNtkDESVersion

public Integer getNtkDESVersion()

Accessor for the NTK DESVersion attribute.

getTopLevelComponents

public List<IDDMSComponent> getTopLevelComponents()

Accessor for an ordered list of the components in this Resource. Components which are missing are not represented in this list (no null entries).

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

getSecurityAttributes

public SecurityAttributes getSecurityAttributes()

Accessor for the Security Attributes. Will always be non-null even if the attributes are not set.

Specified by:

getSecurityAttributes in interface IDDMSComponent

Overrides:

getSecurityAttributes in class AbstractBaseComponent

getNoticeAttributes

public NoticeAttributes getNoticeAttributes()

Accessor for the Notice Attributes. Will always be non-null even if the attributes are not set.

getExtensibleAttributes

public ExtensibleAttributes getExtensibleAttributes()

Accessor for the extensible attributes. Will always be non-null, even if not set.