Format (DDMSence 2.6.0 API)

Object
- buri.ddmsence.AbstractBaseComponent
- - buri.ddmsence.ddms.format.Format

All Implemented Interfaces:: IDDMSComponent

public final class Format
extends AbstractBaseComponent

An immutable implementation of ddms:format.

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

History
Before DDMS 4.0.1, a format element contains a locally defined Media construct. This Media construct is a container for the mimeType,extent, and medium of a resource. It exists only inside of a ddms:format parent, so it is not implemented as a Java object. Starting in DDMS 4.0.1, the Media wrapper has been removed.

Nested Elements

Name

Cardinality

Availability

ddms:extent

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ddms:medium

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ddms:mimeType

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

Attributes

Name

Cardinality

Availability

None.

Validation Rules

Rule

Type

Applicability

The qualified name of this element must be correct.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

A ddms:mimeType must exist.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

Since:: 0.9.b
Author:: Brian Uri!

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Format.Builder
Builder for this DDMS component.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Format.Builder` Builder for this DDMS component.

Field Summary
- Fields inherited from class buri.ddmsence.AbstractBaseComponent
  OUTPUT_TEMPLATES

Constructor Summary

Constructors
Constructor and Description
`Format(nu.xom.Element element)` Constructor for creating a component from a XOM Element
`Format(String mimeType, Extent extent, String medium)` Constructor for creating a component from raw data

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)` Test for logical equality.
`Extent`	`getExtent()` Accessor for the extent
`String`	`getExtentQualifier()` Convenience accessor for the extent qualifier.
`String`	`getExtentValue()` Convenience accessor for the extent value.
`String`	`getHTMLTextOutput(OutputFormat format, String prefix, String suffix)` Renders this component as HTML or Text, with an optional prefix to nest it.
`com.google.gson.JsonObject`	`getJSONObject()` Renders this component as a JSON object, which can either be converted to a JSON string or inserted into the parent JSON object.
`protected String`	`getLocatorSuffix()` Can be overridden to change the locator string used in warnings and errors.
`String`	`getMedium()` Accessor for the medium element child text
`String`	`getMimeType()` Accessor for the mimeType element child text.
`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.
`int`	`hashCode()` Returns a hashcode for the component.
`protected void`	`validate()` Base case for validation.

Methods inherited from class buri.ddmsence.AbstractBaseComponent
addDdms40Warning, addJson, addJson, addJson, addJson, addWarning, addWarnings, buildHTMLTextOutput, buildHTMLTextOutput, buildIndex, buildPrefix, getAttributeValue, getAttributeValue, getChild, getChildTextAsDouble, getDDMSVersion, getName, getNamespace, getPrefix, getQualifiedName, getSecurityAttributes, getValidationWarnings, getXOMElement, getXOMElementCopy, requireAtLeastVersion, requireAtMostVersion, setXOMElement, toHTML, toJSON, toString, toText, toXML, validateWarnings

Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Format
```
public Format(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
  - Format
```
public Format(String mimeType,
              Extent extent,
              String medium)
       throws InvalidDDMSException
```
    Constructor for creating a component from raw data
    
    Parameters:
    
    mimeType - the mimeType element
    
    extent - the extent element
    
    medium - the medium element
    
    Throws:
    
    InvalidDDMSException - if any required information is missing or malformed
- Method Detail
  - validate
```
protected void validate()
                 throws InvalidDDMSException
```
    Description copied from class: AbstractBaseComponent
    
    Base case for validation. This method can be overridden for more in-depth validation. It is always assumed that the subcomponents of a component are already valid.
    
    Overrides:
    
    validate in class AbstractBaseComponent
    
    Throws:
    
    InvalidDDMSException
    
    See Also:
    
    AbstractBaseComponent.validate()
  - getLocatorSuffix
```
protected String getLocatorSuffix()
```
    Description copied from class: AbstractBaseComponent
    
    Can be overridden to change the locator string used in warnings and errors.
    For components such as Format, there are wrapper elements that are not implemented as Java objects. These elements should be included in the XPath string used to identify the source of the error.
    
    For example, if a ddms:extent element has a warning and the ddms:format element reports it, the locator information should be "/ddms:format/ddms:Media/ddms:extent" and not the default of "/ddms:format/ddms:extent"
    
    Overrides:
    
    getLocatorSuffix in class AbstractBaseComponent
    
    Returns:
    
    an empty string, unless overridden.
    
    See Also:
    
    AbstractBaseComponent.getLocatorSuffix()
  - getJSONObject
```
public com.google.gson.JsonObject getJSONObject()
```
    Description copied from class: AbstractBaseComponent
    
    Renders this component as a JSON object, which can either be converted to a JSON string or inserted into the parent JSON object. Although this method is marked a public, it is only intended to be used internally, and is not part of the IDDMSComponent interface. Use the toJSON() method as the public way to get JSON output.
    
    Specified by:
    
    getJSONObject in class AbstractBaseComponent
    
    See Also:
    
    AbstractBaseComponent.getJSONObject()
  - getHTMLTextOutput
```
public String getHTMLTextOutput(OutputFormat format,
                                String prefix,
                                String suffix)
```
    Description copied from class: AbstractBaseComponent
    
    Renders this component as HTML or Text, with an optional prefix to nest it.
    I consider this to be an internal method, that unfortunately must be marked as public to allow cross-package access when generating output. Use toHTML() and toText() as the formal, public methods to generate output.
    
    Specified by:
    
    getHTMLTextOutput in class AbstractBaseComponent
    
    Parameters:
    
    format - the desired format of this output
    
    prefix - an optional prefix to put on each name.
    
    suffix - an optional suffix to append to each name, such as an index.
    
    Returns:
    
    the representation of this component in the specified format
    
    See Also:
    
    AbstractBaseComponent.getHTMLTextOutput(OutputFormat, 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 AbstractBaseComponent
    
    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 AbstractBaseComponent
    
    See Also:
    
    Object.equals(Object)
  - hashCode
```
public int hashCode()
```
    Description copied from class: AbstractBaseComponent
    
    Returns a hashcode for the component.
    This automatically includes any nested components or security attributes.
    
    Overrides:
    
    hashCode in class AbstractBaseComponent
    
    See Also:
    
    Object.hashCode()
  - 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
  - getMimeType
```
public String getMimeType()
```
    Accessor for the mimeType element child text. Will return an empty string if not set, but that cannot occur after instantiation.
  - getExtent
```
public Extent getExtent()
```
    Accessor for the extent
  - getExtentQualifier
```
public String getExtentQualifier()
```
    Convenience accessor for the extent qualifier. Returns an empty string if there is not extent.
  - getExtentValue
```
public String getExtentValue()
```
    Convenience accessor for the extent value. Returns an empty string if there is not extent.
  - getMedium
```
public String getMedium()
```
    Accessor for the medium element child text

Class Format

Nested Class Summary

Field Summary

Fields inherited from class buri.ddmsence.AbstractBaseComponent

Constructor Summary

Method Summary

Methods inherited from class buri.ddmsence.AbstractBaseComponent

Methods inherited from class Object

Constructor Detail

Format

Format

Method Detail

validate

getLocatorSuffix

getJSONObject

getHTMLTextOutput

getNestedComponents

equals

hashCode

getName

getMimeType

getExtent

getExtentQualifier

getExtentValue

getMedium