buri.ddmsence.ddms.resource

Class Type

Object

buri.ddmsence.AbstractBaseComponent

buri.ddmsence.AbstractQualifierValue

buri.ddmsence.ddms.resource.Type

All Implemented Interfaces:

IDDMSComponent

public final class Type
extends AbstractQualifierValue

An immutable implementation of ddms:type.

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

History
Beginning in DDMS 4.0.1, a ddms:type element can contain child text. The intent of this text is to provide further context when the ddms:type element references an IC activity.

Nested Elements
Name Cardinality Availability None.

Attributes
Name Cardinality Availability ddms:qualifier 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ddms:value 0..1 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 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 ddms:qualifier must exist if ddms:value is set. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 The child text 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 Security attributes must not be used before the DDMS version in which they were introduced. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 A ddms:qualifier can be set with no ddms:value. Warning In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 This component can be used with no values set. Warning In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0

Since:

0.9.b

Author:

Brian Uri!

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class buri.ddmsence.AbstractBaseComponent

OUTPUT_TEMPLATES

Constructor Summary

Constructors

Constructor and Description
Type(nu.xom.Element element) Constructor for creating a component from a XOM Element
Type(String description, String qualifier, String value, SecurityAttributes securityAttributes) Constructor for creating a component from raw data

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Test for logical equality.
String	getDescription() Accessor for the description child text, which provides additional context to the qualifier/value pairing of this component.
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.
static String	getName(DDMSVersion version) Accessor for the element name of this component, based on the version of DDMS used
SecurityAttributes	getSecurityAttributes() Accessor for the Security 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.AbstractQualifierValue

getQualifier, getQualifierName, getValue, getValueName

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

Constructor Detail

Type

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

Type

public Type(String description,
            String qualifier,
            String value,
            SecurityAttributes securityAttributes)
     throws InvalidDDMSException

Constructor for creating a component from raw data

Parameters:

description - the child text describing an IC activity, if this component is used to reference an IC activity

qualifier - the value of the qualifier attribute

value - the value of the value attribute

securityAttributes - any 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)

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 AbstractQualifierValue

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 AbstractQualifierValue

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

getDescription

public String getDescription()

Accessor for the description child text, which provides additional context to the qualifier/value pairing of this component. The underlying XOM method which retrieves the child text returns an empty string if not found.

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