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.

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

Locator Attributes (for ddms:link)

xlink:type: the type of link (optional, but fixed as "locator" if set) xlink:href: A target URL (optional) xlink:role: The URI reference identifies some resource that describes the intended property. (optional) xlink:title: Used to describe the meaning of a link or resource in a human-readable fashion, along the same lines as the role or arcrole attribute. (optional) xlink:label: The label attribute provides a name for the link (optional)

Resource Attributes (for ddms:revisionRecall)

xlink:type: (optional, but fixed as "resource" if set) xlink:role: The URI reference identifies some resource that describes the intended property. When no value is supplied, no particular role value is to be inferred. (optional, but must be non-empty if set) xlink:title: Used to describe the meaning of a link or resource in a human-readable fashion, along the same lines as the role or arcrole attribute. (optional) xlink:label: The label attribute provides a name for the link (optional)

Simple Attributes (for ddms:taskID)

xlink:type: (optional, but fixed as "simple" if set) xlink:href: A URL (optional, must be a URI) xlink:role: The URI reference identifies some resource that describes the intended property. When no value is supplied, no particular role value is to be inferred. (optional, but must be non-empty if set) xlink:title: Used to describe the meaning of a link or resource in a human-readable fashion, along the same lines as the role or arcrole attribute. (optional) xlink:arcrole: A URI reference describing an arc role (optional) xlink:show: A token which signifies the behavior intentions for traversal (optional) xlink:actuate: A token which signifies the behavior intentions for traversal (optional)

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.

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

Methods

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	getLabel() Accessor for the label
static XLinkAttributes	getNonNullInstance(XLinkAttributes xlinkAttributes) Returns a non-null instance of XLink attributes.
String	getOutput(boolean isHTML, String prefix) Outputs to HTML or Text with a prefix at the beginning of each meta tag or line.
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()
protected void	validate() Validates the attribute group.

Methods inherited from class buri.ddmsence.AbstractAttributeGroup

getDDMSVersion, getValidationWarnings, getWarnings, validateSameVersion

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

title - the link title (optional)

label - the name of the link (optional)

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

role - the role attribute (optional)

title - the link title (optional)

label - the name of the link (optional)

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

role - the role attribute (optional)

title - the link title (optional)

arcrole - the arcrole (optional)

show - the show token (optional)

actuate - the actuate token (optional)

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

validate

protected void validate()
                 throws InvalidDDMSException

Validates the attribute group.

Rules

If the href attribute is set, it is a valid URI. If the role attribute is set, it is a valid URI, starting in DDMS 4.0.1. If the label attribute is set, it is a valid NCName, starting in DDMS 4.0.1. If the arcrole attribute is set, it is a valid URI. If the show attribute is set, it is a valid token. If the actuate attribute is set, it is a valid token. Does not validate the required nature of any attribute. It is the parent class' responsibility to do that.

Overrides:

validate in class AbstractAttributeGroup

Throws:

InvalidDDMSException - if any required information is missing or malformed

getOutput

public String getOutput(boolean isHTML,
               String prefix)

Description copied from class: AbstractAttributeGroup

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

Specified by:

getOutput in class AbstractAttributeGroup

Parameters:

isHTML - true for HTML, false for Text

prefix - the prefix to add

Returns:

the HTML or Text output

See Also:

AbstractAttributeGroup.getOutput(boolean, 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