buri.ddmsence.ddms.security.ntk

Class Profile

Object

buri.ddmsence.AbstractBaseComponent

buri.ddmsence.AbstractAccessEntity

buri.ddmsence.ddms.security.ntk.Profile

All Implemented Interfaces:

IDDMSComponent

public final class Profile
extends AbstractAccessEntity

An immutable implementation of ntk:AccessProfile.

Nested Elements
ntk:AccessSystemName: The system described by this access record (exactly 1 required), implemented as a SystemName ntk:AccessProfileValue: The value used to describe the profile (1-to-many required), implemented as a ProfileValue

Attributes
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	Profile.Builder Builder for this DDMS component.

Constructor Summary

Constructors

Constructor and Description
Profile(nu.xom.Element element) Constructor for creating a component from a XOM Element
Profile(SystemName systemName, List<ProfileValue> profileValues, SecurityAttributes securityAttributes) Constructor for creating a component 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
protected List<IDDMSComponent>	getNestedComponents() Accessor for a collection of nested components.
String	getOutput(boolean isHTML, String prefix, String suffix) Renders this component as HTML or Text, with an optional prefix to nest it.
List<ProfileValue>	getProfileValues() Accessor for the list of profile values (1-many)
protected void	validate() Validates the component.

Methods inherited from class buri.ddmsence.AbstractAccessEntity

getSecurityAttributes, getSystemName

Methods inherited from class buri.ddmsence.AbstractBaseComponent

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

Methods inherited from class Object

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

Constructor Detail

Profile

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

Profile

public Profile(SystemName systemName,
       List<ProfileValue> profileValues,
       SecurityAttributes securityAttributes)
        throws InvalidDDMSException

Constructor for creating a component from raw data

Parameters:

systemName - the system name (required)

profileValues - the list of values (at least 1 required)

securityAttributes - security attributes (required)

Throws:

InvalidDDMSException - if any required information is missing or malformed

Method Detail

validate

protected void validate()
                 throws InvalidDDMSException

Validates the component.

Rules
The qualified name of the element is correct. At least 1 profile value is required.

Overrides:

validate in class AbstractAccessEntity

Throws:

InvalidDDMSException - if any required information is missing or malformed

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)

getNestedComponents

protected List<IDDMSComponent> getNestedComponents()

Description copied from class: AbstractBaseComponent

Accessor for a collection of nested components. A list such as this is useful for bulk actions, such as checking emptiness, equality, generating hash codes, or applying mass validation.

Overrides:

getNestedComponents in class AbstractAccessEntity

See Also:

AbstractBaseComponent.getNestedComponents()

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 AbstractAccessEntity

See Also:

Object.equals(Object)

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

getProfileValues

public List<ProfileValue> getProfileValues()

Accessor for the list of profile values (1-many)