buri.ddmsence.ddms.summary.xlink

Class XLinkAttributes

Object

buri.ddmsence.AbstractAttributeGroup

buri.ddmsence.ddms.summary.xlink.XLinkAttributes

public final class XLinkAttributes
extends AbstractAttributeGroup

Attribute group for the XLINK attributes.

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

This class only models the subset of attributes and values that are employed by the DDMS specification. Determinations about whether an attribute is optional or required depend on the decorated class (Link, RevisionRecall, or TaskID).

History
None.

Nested Elements
Name Cardinality Availability None.

Attributes (in a ddms:link)
Name Cardinality Availability xlink:type 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 xlink:href 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 xlink:role 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 xlink:title 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 xlink:label 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0

Attributes (in a ddms:revisionRecall)
Name Cardinality Availability xlink:type 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 xlink:role 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 xlink:title 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 xlink:label 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0

Attributes (in a ddms:taskID)
Name Cardinality Availability xlink:type 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 xlink:href 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 xlink:role 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 xlink:title 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 xlink:arcrole 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 xlink:show 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 xlink:actuate 0..1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0

Validation Rules

Rule Type Applicability If set, xlink:href must be a valid URI. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 If set, xlink:arcrole must be a valid URI. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 If set, xlink:show must be a valid token. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 If set, xlink:actuate must be a valid token. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 If set, xlink:role must be a valid URI. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 If set, xlink:label msut be a valid NCName. Error 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	XLinkAttributes.Builder Builder for these attributes.

Field Summary

Fields inherited from class buri.ddmsence.AbstractAttributeGroup

INCOMPATIBLE_VERSION_MESSAGE

Constructor Summary

Constructors

Constructor and Description
XLinkAttributes() Constructor which builds from raw data for an unknown type.
XLinkAttributes(nu.xom.Element element) Base constructor
XLinkAttributes(String role, String title, String label) Constructor which builds from raw data for a resource link.
XLinkAttributes(String href, String role, String title, String label) Constructor which builds from raw data for a locator link.
XLinkAttributes(String href, String role, String title, String arcrole, String show, String actuate) Constructor which builds from raw data for a simple link.

Method Summary

Modifier and Type	Method and Description
void	addTo(nu.xom.Element element) Convenience method to add these attributes onto an existing XOM Element
boolean	equals(Object obj)
String	getActuate() Accessor for the actuate
String	getArcrole() Accessor for the arcrole
String	getHref() Accessor for the href
String	getHTMLTextOutput(OutputFormat format, String prefix) Outputs to HTML or Text with a prefix at the beginning of each meta tag or line.
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.
String	getLabel() Accessor for the label
String	getName() Returns a name that describes this attribute group.
static XLinkAttributes	getNonNullInstance(XLinkAttributes xlinkAttributes) Returns a non-null instance of XLink attributes.
String	getRole() Accessor for the role
String	getShow() Accessor for the show
String	getTitle() Accessor for the title
String	getType() Accessor for the type
int	hashCode()
boolean	isEmpty() Checks if any attributes have been set.
protected void	validate(DDMSVersion version) Validates the attribute group.
protected void	validateCompatibleVersion(DDMSVersion newParentVersion) Compares the DDMS version of these attributes to another DDMS version

Methods inherited from class buri.ddmsence.AbstractAttributeGroup

addJson, addJson, getNamespace, getValidationWarnings, getWarnings, setNamespace

Methods inherited from class Object

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

Constructor Detail

XLinkAttributes

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

Base constructor

Parameters:

element - the XOM element which is decorated with these attributes.

Throws:

InvalidDDMSException

XLinkAttributes

public XLinkAttributes()
                throws InvalidDDMSException

Constructor which builds from raw data for an unknown type.

Throws:

InvalidDDMSException

XLinkAttributes

public XLinkAttributes(String role,
                       String title,
                       String label)
                throws InvalidDDMSException

Constructor which builds from raw data for a resource link.

Parameters:

role - the role attribute

title - the link title

label - the name of the link

Throws:

InvalidDDMSException - if any required information is missing or malformed

XLinkAttributes

public XLinkAttributes(String href,
                       String role,
                       String title,
                       String label)
                throws InvalidDDMSException

Constructor which builds from raw data for a locator link.

Parameters:

href - the link href

role - the role attribute

title - the link title

label - the name of the link

Throws:

InvalidDDMSException - if any required information is missing or malformed

XLinkAttributes

public XLinkAttributes(String href,
                       String role,
                       String title,
                       String arcrole,
                       String show,
                       String actuate)
                throws InvalidDDMSException

Constructor which builds from raw data for a simple link.

Parameters:

href - the link href

role - the role attribute

title - the link title

arcrole - the arcrole

show - the show token

actuate - the actuate token

Throws:

InvalidDDMSException - if any required information is missing or malformed

Method Detail

getNonNullInstance

public static XLinkAttributes getNonNullInstance(XLinkAttributes xlinkAttributes)
                                          throws InvalidDDMSException

Returns a non-null instance of XLink attributes. If the instance passed in is not null, it will be returned.

Parameters:

xlinkAttributes - the attributes to return by default

Returns:

a non-null attributes instance

Throws:

InvalidDDMSException - if there are problems creating the empty attributes instance

addTo

public void addTo(nu.xom.Element element)
           throws InvalidDDMSException

Convenience method to add these attributes onto an existing XOM Element

Parameters:

element - the element to decorate

Throws:

InvalidDDMSException - if the DDMS version of the element is different

validateCompatibleVersion

protected void validateCompatibleVersion(DDMSVersion newParentVersion)
                                  throws InvalidDDMSException

Compares the DDMS version of these attributes to another DDMS version

Parameters:

newParentVersion - the version to test

Throws:

InvalidDDMSException - if the versions do not match

validate

protected void validate(DDMSVersion version)
                 throws InvalidDDMSException

Validates the attribute group.

Overrides:

validate in class AbstractAttributeGroup

Parameters:

version - the DDMS version to validate against. This cannot be stored in the attribute group because some DDMSVersions have the same attribute XML namespace (e.g. XLink, ISM, NTK, GML after DDMS 2.0).

Throws:

InvalidDDMSException - if any required information is missing or malformed

getJSONObject

public com.google.gson.JsonObject getJSONObject()

Description copied from class: AbstractAttributeGroup

Renders this component as a JSON object, which can either be converted to a JSON string or inserted into the parent JSON object.

I consider this to be an internal method, that unfortunately must be marked as public to allow cross-package access when generating output. Use toJSON() as the formal, public method to generate output.

Specified by:

getJSONObject in class AbstractAttributeGroup

See Also:

AbstractAttributeGroup.getJSONObject()

isEmpty

public boolean isEmpty()

Description copied from class: AbstractAttributeGroup

Checks if any attributes have been set.

Specified by:

isEmpty in class AbstractAttributeGroup

Returns:

true if no attributes have values, false otherwise

See Also:

AbstractAttributeGroup.isEmpty()

getName

public String getName()

Description copied from class: AbstractAttributeGroup

Returns a name that describes this attribute group. The format of the name is the class name with a lower-case first letter. This method is used in JSON output.

Specified by:

getName in class AbstractAttributeGroup

See Also:

AbstractAttributeGroup.getName()

getHTMLTextOutput

public String getHTMLTextOutput(OutputFormat format,
                                String prefix)

Description copied from class: AbstractAttributeGroup

Outputs to HTML or Text with a prefix at the beginning of each meta tag or line.

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 AbstractAttributeGroup

Parameters:

format - the desired format of this output

prefix - the prefix to add

Returns:

the output

See Also:

AbstractAttributeGroup.getHTMLTextOutput(OutputFormat, String)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(Object)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

getType

public String getType()

Accessor for the type

getHref

public String getHref()

Accessor for the href

getRole

public String getRole()

Accessor for the role

getTitle

public String getTitle()

Accessor for the title

getLabel

public String getLabel()

Accessor for the label

getArcrole

public String getArcrole()

Accessor for the arcrole

getShow

public String getShow()

Accessor for the show

getActuate

public String getActuate()

Accessor for the actuate