buri.ddmsence

Class AbstractAttributeGroup

Object

buri.ddmsence.AbstractAttributeGroup

Direct Known Subclasses:

ExtensibleAttributes, NoticeAttributes, SecurityAttributes, SRSAttributes, XLinkAttributes

public abstract class AbstractAttributeGroup
extends Object

Top-level base class for attribute groups, such as SecurityAttributes.

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

Extensions of this class are generally expected to be immutable. It is assumed that after the constructor on a component has been called, the component will be well-formed and valid.

History
None.

Nested Elements
Name Cardinality Availability None.

Attributes
Name Cardinality Availability None. Extending classes will have additional attributes.

Validation Rules
Rule Type Applicability No rules are validated at this level. Extending classes may have additional rules.

Since:

1.1.0

Author:

Brian Uri!

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	INCOMPATIBLE_VERSION_MESSAGE

Constructor Summary

Constructors

Constructor and Description
AbstractAttributeGroup() Empty constructor

Method Summary

Methods

Modifier and Type	Method and Description
protected String	getNamespace() Accessor for the XML namespace of these attributes
abstract String	getOutput(boolean isHTML, String prefix) Outputs to HTML or Text with a prefix at the beginning of each meta tag or line.
List<ValidationMessage>	getValidationWarnings() Returns a list of any warning messages that occurred during validation.
protected List<ValidationMessage>	getWarnings() Accessor for the list of validation warnings.
protected void	setNamespace(String namespace) Accessor for the XML namespace of these attributes
protected void	validate(DDMSVersion version) Base validation case for attribute groups.

Methods inherited from class Object

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

Field Detail

INCOMPATIBLE_VERSION_MESSAGE

protected static final String INCOMPATIBLE_VERSION_MESSAGE

See Also:

Constant Field Values

Constructor Detail

AbstractAttributeGroup

public AbstractAttributeGroup()

Empty constructor

Method Detail

validate

protected void validate(DDMSVersion version)
                 throws InvalidDDMSException

Base validation case for attribute groups.

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

getValidationWarnings

public List<ValidationMessage> getValidationWarnings()

Returns a list of any warning messages that occurred during validation. Warnings do not prevent a valid component from being formed.

Returns:

a list of warnings

getWarnings

protected List<ValidationMessage> getWarnings()

Accessor for the list of validation warnings.

This is the private copy that should be manipulated during validation. Lazy initialization.

Returns:

an editable list of warnings

getOutput

public abstract String getOutput(boolean isHTML,
               String prefix)

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

Parameters:

isHTML - true for HTML, false for Text

prefix - the prefix to add

Returns:

the HTML or Text output

getNamespace

protected String getNamespace()

Accessor for the XML namespace of these attributes

setNamespace

protected void setNamespace(String namespace)

Accessor for the XML namespace of these attributes