buri.ddmsence.ddms.security.ntk

Class SystemName

Object

buri.ddmsence.AbstractBaseComponent

buri.ddmsence.AbstractNtkString

buri.ddmsence.ddms.security.ntk.SystemName

All Implemented Interfaces:

IDDMSComponent

public final class SystemName
extends AbstractNtkString

An immutable implementation of ntk:AccessSystemName.

Attributes

ntk:id: A unique XML identifier (optional) ntk:IDReference: A cross-reference to a unique identifier (optional) ntk:qualifier: A user-defined property within an element for general purpose processing used with block objects to provide supplemental information over and above that conveyed by the element name (optional) SecurityAttributes: The classification and ownerProducer attributes are required.

Since:

2.0.0

Author:

Brian Uri!

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
SystemName(nu.xom.Element element) Constructor for creating a component from a XOM Element
SystemName(String value, String id, String idReference, String qualifier, SecurityAttributes securityAttributes) Constructor which builds from raw data.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Test for logical equality.
static String	getName(DDMSVersion version) Accessor for the element name of this component, based on the version of DDMS used
String	getOutput(boolean isHTML, String prefix, String suffix) Renders this component as HTML or Text, with an optional prefix to nest it.
protected void	validate() Validates the component.

Methods inherited from class buri.ddmsence.AbstractNtkString

getID, getIDReference, getQualifier, getSecurityAttributes, getValue, hashCode

Methods inherited from class buri.ddmsence.AbstractBaseComponent

addDdms40Warning, addWarning, addWarnings, buildIndex, buildOutput, buildOutput, buildPrefix, getAttributeValue, getAttributeValue, getChild, getChildTextAsDouble, getDDMSVersion, getLocatorSuffix, getName, getNamespace, getNestedComponents, getPrefix, getQualifiedName, getStringAsDouble, getValidationWarnings, getXOMElement, getXOMElementCopy, requireVersion, setXOMElement, toHTML, toString, toText, toXML, validateWarnings

Methods inherited from class Object

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

Constructor Detail

SystemName

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

SystemName

public SystemName(String value,
          String id,
          String idReference,
          String qualifier,
          SecurityAttributes securityAttributes)
           throws InvalidDDMSException

Constructor which builds from raw data.

Parameters:

value - the value of the element's child text

id - the NTK ID (optional)

idReference - a reference to an NTK ID (optional)

qualifier - an NTK qualifier (optional)

securityAttributes - the security attributes

Throws:

InvalidDDMSException

Method Detail

validate

protected void validate()
                 throws InvalidDDMSException

Validates the component.

Rules
The qualified name of the element is correct.

Overrides:

validate in class AbstractNtkString

Throws:

InvalidDDMSException

See Also:

AbstractBaseComponent.validate()

getOutput

public String getOutput(boolean isHTML,
               String prefix,
               String suffix)

Description copied from class: AbstractBaseComponent

Renders this component as HTML or Text, with an optional prefix to nest it.

Specified by:

getOutput in class AbstractBaseComponent

Parameters:

isHTML - true for HTML, false for Text.

prefix - an optional prefix to put on each name.

suffix - an optional suffix to append to each name, such as an index.

Returns:

the HTML or Text representation of this component

See Also:

AbstractBaseComponent.getOutput(boolean, String, String)

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

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 AbstractNtkString

See Also:

Object.equals(Object)