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.

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.

Since:

1.1.0

Author:

Brian Uri!

Constructor Summary

Constructors

Constructor and Description
AbstractAttributeGroup(String xmlNamespace) Constructor which stores the XML namespace of the enclosing element

Method Summary

Methods

Modifier and Type	Method and Description
DDMSVersion	getDDMSVersion() Accessor for the DDMS namespace on the enclosing element.
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	validate() Base validation case for attribute groups.
protected void	validateSameVersion(DDMSVersion version) Compares the DDMS version of these attributes to another DDMS version

Methods inherited from class Object

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

Constructor Detail

AbstractAttributeGroup

public AbstractAttributeGroup(String xmlNamespace)

Constructor which stores the XML namespace of the enclosing element

Method Detail

getDDMSVersion

public DDMSVersion getDDMSVersion()

Accessor for the DDMS namespace on the enclosing element.

validate

protected void validate()
                 throws InvalidDDMSException

Base validation case for attribute groups.

Rules
No rules are validated at this level. Extending classes may have additional rules.

Throws:

InvalidDDMSException - if any required information is missing or malformed

validateSameVersion

protected void validateSameVersion(DDMSVersion version)
                            throws InvalidDDMSException

Compares the DDMS version of these attributes to another DDMS version

Parameters:

version - the version to test

Throws:

InvalidDDMSException - if the versions do not match

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