buri.ddmsence.ddms.resource

Class Service

Object

buri.ddmsence.AbstractBaseComponent

buri.ddmsence.AbstractRoleEntity

buri.ddmsence.ddms.resource.Service

All Implemented Interfaces:

IDDMSComponent, IRoleEntity

public final class Service
extends AbstractRoleEntity

An immutable implementation of a ddms:service element.

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

History
The name of this element was made lowercase in DDMS 4.0.1.

Nested Elements
Name Cardinality Availability ddms:name 1..* In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ddms:phone 0..* In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ddms:email 0..* In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ddms:affiliation 0..* In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0

Attributes
Name Cardinality Availability any:<extensibleAttributes> 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 At least 1 ddms:name must exist. Error 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	Service.Builder Builder for this DDMS component.

Field Summary

Fields inherited from class buri.ddmsence.AbstractBaseComponent

OUTPUT_TEMPLATES

Constructor Summary

Constructors

Constructor and Description
Service(nu.xom.Element element) Constructor for creating a component from a XOM Element
Service(List<String> names, List<String> phones, List<String> emails) Deprecated. A new constructor was added for DDMS 5.0 to support ddms:affiliation. This constructor is preserved for backwards compatibility, but may disappear in the next major release.
Service(List<String> names, List<String> phones, List<String> emails, List<String> affiliations, ExtensibleAttributes extensions) Constructor for creating a component from raw data.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Test for logical equality.
List<String>	getAffiliations() Accessor for the affiliations of the service
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
int	hashCode() Returns a hashcode for the component.
protected void	validate() Base case for validation.

Methods inherited from class buri.ddmsence.AbstractRoleEntity

getEmails, getExtensibleAttributes, getNames, getPhones

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, getSecurityAttributes, getValidationWarnings, getXOMElement, getXOMElementCopy, requireAtLeastVersion, requireAtMostVersion, setXOMElement, toHTML, toJSON, toString, toText, toXML, validateWarnings

Methods inherited from class Object

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

Methods inherited from interface buri.ddmsence.ddms.IDDMSComponent

getName, getNamespace, getPrefix, getQualifiedName, getSecurityAttributes, getValidationWarnings, getXOMElementCopy, toHTML, toJSON, toText, toXML

Constructor Detail

Service

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

Service

public Service(List<String> names,
               List<String> phones,
               List<String> emails)
        throws InvalidDDMSException

Deprecated. A new constructor was added for DDMS 5.0 to support ddms:affiliation. This constructor is preserved for backwards compatibility, but may disappear in the next major release.

Constructor for creating a component from raw data.

Parameters:

names - an ordered list of names

phones - an ordered list of phone numbers

emails - an ordered list of email addresses

Throws:

InvalidDDMSException

Service

public Service(List<String> names,
               List<String> phones,
               List<String> emails,
               List<String> affiliations,
               ExtensibleAttributes extensions)
        throws InvalidDDMSException

Constructor for creating a component from raw data.

Parameters:

names - an ordered list of names

phones - an ordered list of phone numbers

emails - an ordered list of email addresses

affiliations - the affiliations of the service

extensions - extensible attributes

Throws:

InvalidDDMSException

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 AbstractRoleEntity

Throws:

InvalidDDMSException

See Also:

AbstractRoleEntity.validate()

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.

Overrides:

getJSONObject in class AbstractRoleEntity

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.

Overrides:

getHTMLTextOutput in class AbstractRoleEntity

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 AbstractRoleEntity

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 AbstractRoleEntity

See Also:

Object.hashCode()

getAffiliations

public List<String> getAffiliations()

Accessor for the affiliations of the service

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