MetacardInfo (DDMSence 2.6.0 API)

Object
- buri.ddmsence.AbstractBaseComponent
- - buri.ddmsence.ddms.metacard.MetacardInfo

All Implemented Interfaces:: IDDMSComponent

public final class MetacardInfo
extends AbstractBaseComponent

An immutable implementation of ddms:metacardInfo.

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

History
None.

Nested Elements

Name

Cardinality

Availability

ddms:identifier

1..*

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ddms:dates

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ddms:contributor

0..*

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ddms:creator

0..*

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ddms:pointOfContact

0..*

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ddms:publisher

0..*

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ddms:description

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ddms:processingInfo

0..*

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ddms:revisionRecall

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ddms:recordsManagementInfo

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ddms:noticeList

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ntk:Access

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

Attributes

Name

Cardinality

Availability

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

At least 1 ddms:identifier must exist.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

A ddms:dates must exist.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

At least 1 ddms:publisher must exist.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

At least 1 producer of any kind must exist.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ddms:noticeList 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

ddms:noticeList must not be used after the DDMS version in which it was removed.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ntk:Access 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

ntk:Access must not be used after the DDMS version in which it was removed.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ntk:Access may cause issues for DDMS 4.0.1 systems.

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 MetacardInfo.Builder
Builder for this DDMS component.

Field Summary
- Fields inherited from class buri.ddmsence.AbstractBaseComponent
  OUTPUT_TEMPLATES

Constructor Summary

Constructors
Constructor and Description
`MetacardInfo(nu.xom.Element element)` Constructor for creating a component from a XOM Element
`MetacardInfo(List<IDDMSComponent> childComponents, SecurityAttributes securityAttributes)` Constructor for creating a component from raw data

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)` Test for logical equality.
`Access`	`getAccess()` Accessor for the Access.
`List<IDDMSComponent>`	`getChildComponents()` Accessor for an ordered list of the components in this metcardInfo.
`List<Contributor>`	`getContributors()` Accessor for a list of all Contributor entities
`List<Creator>`	`getCreators()` Accessor for a list of all Creator entities
`Dates`	`getDates()` Accessor for the dates
`Description`	`getDescription()` Accessor for the description
`String`	`getHTMLTextOutput(OutputFormat format, String prefix, String suffix)` Renders this component as HTML or Text, with an optional prefix to nest it.
`List<Identifier>`	`getIdentifiers()` Accessor for a list of all identifiers
`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.
`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.
`NoticeList`	`getNoticeList()` Accessor for the noticeList
`List<PointOfContact>`	`getPointOfContacts()` Accessor for a list of all PointOfContact entities
`List<ProcessingInfo>`	`getProcessingInfos()` Accessor for the processing information
`List<Publisher>`	`getPublishers()` Accessor for a list of all Publisher entities
`RecordsManagementInfo`	`getRecordsManagementInfo()` Accessor for the recordsManagementInfo
`RevisionRecall`	`getRevisionRecall()` Accessor for the revisionRecall
`SecurityAttributes`	`getSecurityAttributes()` Accessor for the Security Attributes.
`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, hashCode, requireAtLeastVersion, requireAtMostVersion, setXOMElement, toHTML, toJSON, toString, toText, toXML

Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MetacardInfo
```
public MetacardInfo(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
  - MetacardInfo
```
public MetacardInfo(List<IDDMSComponent> childComponents,
                    SecurityAttributes securityAttributes)
             throws InvalidDDMSException
```
    Constructor for creating a component from raw data
    Because there are so many possible components in a MetacardInfo instance, they are passed in as a collection, similar to the approach used for top-level components in a Resource. If any component does not belong in a MetacardInfo instance, an InvalidDDMSException will be thrown.
    
    The order of different types of components does not matter here. 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.
    
    Parameters:
    
    childComponents - any components that belong in this MetacardInfo
    
    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)
  - 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
  - getChildComponents
```
public List<IDDMSComponent> getChildComponents()
```
    Accessor for an ordered list of the components in this metcardInfo. Components which are missing are not represented in this list (no null entries).
  - getIdentifiers
```
public List<Identifier> getIdentifiers()
```
    Accessor for a list of all identifiers
  - getDates
```
public Dates getDates()
```
    Accessor for the dates
  - getContributors
```
public List<Contributor> getContributors()
```
    Accessor for a list of all Contributor entities
  - getCreators
```
public List<Creator> getCreators()
```
    Accessor for a list of all Creator entities
  - getPointOfContacts
```
public List<PointOfContact> getPointOfContacts()
```
    Accessor for a list of all PointOfContact entities
  - getPublishers
```
public List<Publisher> getPublishers()
```
    Accessor for a list of all Publisher entities
  - getDescription
```
public Description getDescription()
```
    Accessor for the description
  - getProcessingInfos
```
public List<ProcessingInfo> getProcessingInfos()
```
    Accessor for the processing information
  - getRevisionRecall
```
public RevisionRecall getRevisionRecall()
```
    Accessor for the revisionRecall
  - getRecordsManagementInfo
```
public RecordsManagementInfo getRecordsManagementInfo()
```
    Accessor for the recordsManagementInfo
  - getNoticeList
```
public NoticeList getNoticeList()
```
    Accessor for the noticeList
  - getAccess
```
public Access getAccess()
```
    Accessor for the Access. May be null.
  - 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

Class MetacardInfo

Nested Class Summary

Field Summary

Fields inherited from class buri.ddmsence.AbstractBaseComponent

Constructor Summary

Method Summary

Methods inherited from class buri.ddmsence.AbstractBaseComponent

Methods inherited from class Object

Constructor Detail

MetacardInfo

MetacardInfo

Method Detail

validate

validateWarnings

getJSONObject

getHTMLTextOutput

getNestedComponents

equals

getName

getChildComponents

getIdentifiers

getDates

getContributors

getCreators

getPointOfContacts

getPublishers

getDescription

getProcessingInfos

getRevisionRecall

getRecordsManagementInfo

getNoticeList

getAccess

getSecurityAttributes