buri.ddmsence.ddms

Interface IDDMSComponent

All Known Subinterfaces:

IRoleEntity, ITspiAddress, ITspiShape

All Known Implementing Classes:

AbstractAccessEntity, AbstractBaseComponent, AbstractNtkString, AbstractProducerRole, AbstractQualifierValue, AbstractRoleEntity, AbstractSimpleString, AbstractTaskingRole, AbstractTspiAddress, AbstractTspiShape, Access, Addressee, ApplicationSoftware, ApproximableDate, BoundingBox, BoundingGeometry, Category, Circle, Contributor, CountryCode, Creator, Dates, Description, Details, Ellipse, Envelope, ExtensibleElement, Extent, FacilityIdentifier, Format, GeneralAddressClass, GeographicIdentifier, GeospatialCoverage, Group, GroupValue, Identifier, Individual, IndividualValue, IntersectionAddress, Keyword, LandmarkAddress, Language, Link, MetacardInfo, NonStateActor, Notice, NoticeList, NoticeText, NumberedThoroughfareAddress, Organization, Person, Point, Point, PointOfContact, Polygon, Polygon, Position, PostalAddress, ProcessingInfo, ProductionMetric, Profile, ProfileList, ProfileValue, Publisher, RecordKeeper, RecordsManagementInfo, RelatedResource, RequesterInfo, Resource, ResourceManagement, RevisionRecall, Rights, Security, Service, Source, SubDivisionCode, SubjectCoverage, SubOrganization, Subtitle, SystemName, TaskID, TaskingInfo, TemporalCoverage, Title, TwoNumberAddressRange, Type, Unknown, UnnumberedThoroughfareAddress, USPSGeneralDeliveryOffice, USPSPostalDeliveryBox, USPSPostalDeliveryRoute, VerticalExtent, VirtualCoverage

public interface IDDMSComponent

Interface for a single DDMS element.

All DDMS components should be valid after instantiation and can output themselves in various formats. Implementation classes are divided up into packages based on the five Core sets: Metacard Info, Security, Resource, Summary Content, and Format.

Accessors which return string-based data will always favour an empty string over a null value.

In general, Java classes are implemented for:

• Elements which are explicitly declared as DDMS Categories in the DDMS documentation are always implemented (ddms:identifier).
• Elements which merely enclose important data AND which have no special attributes are never implemented (ddms:Media).
• Data which can be represented as a simple Java type AND which has no special attributes is represented as a simple Java type (ddms:email).
• Attributes are generally implemented as properties on an Object. The exceptions to this are the ISM, SRS, and XLink AttributeGroup, which decorates many DDMS components.

Since:

0.9.b

Author:

Brian Uri!

Method Summary

Modifier and Type	Method and Description
String	getName() Accessor for the name of the component
String	getNamespace() Accessor for the XML namespace of the component
String	getPrefix() Accessor for the prefix of the component, without a trailing colon
String	getQualifiedName() Accessor for the name of the component, including the prefix
SecurityAttributes	getSecurityAttributes() Returns any security attributes attached to this component.
List<ValidationMessage>	getValidationWarnings() Returns a list of any warning messages that occurred during validation.
nu.xom.Element	getXOMElementCopy() Accessor for a copy of the underlying XOM element.
String	toHTML() Renders this component as HTML.
String	toJSON() Renders this component as JSON.
String	toText() Renders this component as Text.
String	toXML() Renders this component as XML.

Method Detail

getPrefix

String getPrefix()

Accessor for the prefix of the component, without a trailing colon

Returns:

the prefix

getName

String getName()

Accessor for the name of the component

Returns:

the name, without prefix

getNamespace

String getNamespace()

Accessor for the XML namespace of the component

Returns:

the namespace

getQualifiedName

String getQualifiedName()

Accessor for the name of the component, including the prefix

Returns:

the name, with prefix if available

getSecurityAttributes

SecurityAttributes getSecurityAttributes()

Returns any security attributes attached to this component. If the component is not allowed to have attributes, this will be null. Otherwise, a valid SecurityAttributes object will be returned, even if none of its properties are set.

getValidationWarnings

List<ValidationMessage> getValidationWarnings()

Returns a list of any warning messages that occurred during validation. Warnings do not prevent a valid component from being formed. A parent component should also claim the warnings of its child elements.

Returns:

a list of warnings

toHTML

String toHTML()

Renders this component as HTML.

Returns:

the HTML representation of this component

toJSON

String toJSON()

Renders this component as JSON. Use the output.json.prettyPrint property to control pretty printing of the output.

Returns:

the JSON representation of this component

toText

String toText()

Renders this component as Text. Use the output.indexLevel property to add indices to the output.

Returns:

the text-based representation of this component

toXML

String toXML()

Renders this component as XML. Use the output.indexLevel property to add indices to the output.

Returns:

the XML representation of this component

getXOMElementCopy

nu.xom.Element getXOMElementCopy()

Accessor for a copy of the underlying XOM element. This allows a XOM tree to be built from DDMS data when traversing a list of IDDMSComponents.