IIOMetadataFormat JDK 1.6)

Methods

public boolean canNodeAppear (String elementName, ImageTypeSpecifier imageType)

Returns true if the element (and the subtree below it) is allowed to appear in a metadata document for an image of the given type, defined by an ImageTypeSpecifier.

Returns true if the element (and the subtree below
it) is allowed to appear in a metadata document for an image of
the given type, defined by an ImageTypeSpecifier.
For example, a metadata document format might contain an
element that describes the primary colors of the image, which
would not be allowed when writing a grayscale image.
Returns: true if the node is meaningful for images of the given type.
Parameters:
- elementName - the name of the element being queried.
- imageType - an ImageTypeSpecifier indicating the type of the image that will be associated with the metadata.

public int getAttributeDataType (String elementName, String attrName)

Returns one of the constants starting with DATATYPE_, indicating the format and interpretation of the value of the given attribute within th enamed element.

Returns one of the constants starting with
DATATYPE_, indicating the format and
interpretation of the value of the given attribute within th
enamed element. If getAttributeValueType returns
VALUE_LIST, then the legal value is a
whitespace-spearated list of values of the returned datatype.
Returns: one of the DATATYPE_* constants.
Parameters:
- elementName - the name of the element being queried.
- attrName - the name of the attribute being queried.
Throws:
- IllegalArgumentException - if elementName is null or is not a legal element name for this format.
- IllegalArgumentException - if attrName is null or is not a legal attribute name for this element.

public String getAttributeDefaultValue (String elementName, String attrName)

Returns the default value of the named attribute, if it is not explictly present within the named element, as a String, or null if no default value is available.

Returns the default value of the named attribute, if it is not
explictly present within the named element, as a
String, or null if no default value
is available.
Returns: a String containing the default value, or null.
Parameters:
- elementName - the name of the element being queried.
- attrName - the name of the attribute being queried.
Throws:
- IllegalArgumentException - if elementName is null or is not a legal element name for this format.
- IllegalArgumentException - if attrName is null or is not a legal attribute name for this element.

public String getAttributeDescription (String elementName, String attrName, Locale locale)

Returns a String containing a description of the named attribute, or null.

Returns a String containing a description of the named attribute, or null. The desciption will be localized for the supplied Locale if possible.

If locale is null, the current default Locale returned by Locale.getLocale will be used.
Returns: the attribute description.
Parameters:
- elementName - the name of the element.
- attrName - the name of the attribute.
- locale - the Locale for which localization will be attempted.
Throws:
- IllegalArgumentException - if elementName is null, or is not a legal element name for this format.
- IllegalArgumentException - if attrName is null or is not a legal attribute name for this element.

public String getAttributeEnumerations (String elementName, String attrName)

Returns an array of Strings containing the legal enumerated values for the given attribute within the named element.

Returns an array of Strings containing the legal
enumerated values for the given attribute within the named
element. This method should only be called if
getAttributeValueType returns
VALUE_ENUMERATION.
Returns: an array of Strings.
Parameters:
- elementName - the name of the element being queried.
- attrName - the name of the attribute being queried.
Throws:
- IllegalArgumentException - if elementName is null or is not a legal element name for this format.
- IllegalArgumentException - if attrName is null or is not a legal attribute name for this element.
- IllegalArgumentException - if the given attribute is not defined as an enumeration.

public int getAttributeListMaxLength (String elementName, String attrName)

Returns the maximum number of list items that may be used to define this attribute.

Returns the maximum number of list items that may be used to
define this attribute. A value of
Integer.MAX_VALUE may be used to specify that
there is no upper bound. The attribute itself is defined as a
String containing multiple whitespace-separated
items. This method should only be called if
getAttributeValueType returns
VALUE_LIST.
Returns: the largest legal number of list items for the attribute.
Parameters:
- elementName - the name of the element being queried.
- attrName - the name of the attribute being queried.
Throws:
- IllegalArgumentException - if elementName is null or is not a legal element name for this format.
- IllegalArgumentException - if attrName is null or is not a legal attribute name for this element.
- IllegalArgumentException - if the given attribute is not defined as a list.

public int getAttributeListMinLength (String elementName, String attrName)

Returns the minimum number of list items that may be used to define this attribute.

Returns the minimum number of list items that may be used to
define this attribute. The attribute itself is defined as a
String containing multiple whitespace-separated
items. This method should only be called if
getAttributeValueType returns
VALUE_LIST.
Returns: the smallest legal number of list items for the attribute.
Parameters:
- elementName - the name of the element being queried.
- attrName - the name of the attribute being queried.
Throws:
- IllegalArgumentException - if elementName is null or is not a legal element name for this format.
- IllegalArgumentException - if attrName is null or is not a legal attribute name for this element.
- IllegalArgumentException - if the given attribute is not defined as a list.

public String getAttributeMaxValue (String elementName, String attrName)

Returns the maximum legal value for the attribute.

Returns the maximum legal value for the attribute. Whether
this value is inclusive or exclusive may be determined by the
value of getAttributeValueType. The value is
returned as a String; its interpretation is
dependent on the value of getAttributeDataType.
This method should only be called if
getAttributeValueType returns
VALUE_RANGE_*.
Returns: a String containing the largest legal value for the attribute.
Parameters:
- elementName - the name of the element being queried, as a String.
- attrName - the name of the attribute being queried.
Throws:
- IllegalArgumentException - if elementName is null or is not a legal element name for this format.
- IllegalArgumentException - if attrName is null or is not a legal attribute name for this element.
- IllegalArgumentException - if the given attribute is not defined as a range.

public String getAttributeMinValue (String elementName, String attrName)

Returns the minimum legal value for the attribute.

Returns the minimum legal value for the attribute. Whether
this value is inclusive or exclusive may be determined by the
value of getAttributeValueType. The value is
returned as a String; its interpretation is
dependent on the value of getAttributeDataType.
This method should only be called if
getAttributeValueType returns
VALUE_RANGE_*.
Returns: a String containing the smallest legal value for the attribute.
Parameters:
- elementName - the name of the element being queried.
- attrName - the name of the attribute being queried.
Throws:
- IllegalArgumentException - if elementName is null or is not a legal element name for this format.
- IllegalArgumentException - if attrName is null or is not a legal attribute name for this element.
- IllegalArgumentException - if the given attribute is not defined as a range.

public String getAttributeNames (String elementName)

Returns an array of Strings listing the names of the attributes that may be associated with the named element.

Returns an array of Strings listing the names of
the attributes that may be associated with the named element.
Returns: an array of Strings.
Parameters:
- elementName - the name of the element being queried.
Throws:
- IllegalArgumentException - if elementName is null or is not a legal element name for this format.

public int getAttributeValueType (String elementName, String attrName)

Returns one of the constants starting with VALUE_,
indicating whether the values of the given attribute within the
named element are arbitrary, constrained to lie within a
specified range, constrained to be one of a set of enumerated
values, or are a whitespace-separated list of arbitrary values.
Returns: one of the VALUE_* constants.
Parameters:
- elementName - the name of the element being queried.
- attrName - the name of the attribute being queried.
Throws:
- IllegalArgumentException - if elementName is null or is not a legal element name for this format.
- IllegalArgumentException - if attrName is null or is not a legal attribute name for this element.

public String getChildNames (String elementName)

Returns an array of Strings indicating the names of the element which are allowed to be children of the named element, in the order in which they should appear.

Returns an array of Strings indicating the names
of the element which are allowed to be children of the named
element, in the order in which they should appear. If the
element cannot have children, null is returned.
Returns: an array of Strings, or null.
Parameters:
- elementName - the name of the element being queried.
Throws:
- IllegalArgumentException - if elementName is null or is not a legal element name for this format.

public int getChildPolicy (String elementName)

Returns one of the constants starting with CHILD_POLICY_, indicating the legal pattern of children for the named element.

Returns one of the constants starting with
CHILD_POLICY_, indicating the legal pattern of
children for the named element.
Returns: one of the CHILD_POLICY_* constants.
Parameters:
- elementName - the name of the element being queried.
Throws:
- IllegalArgumentException - if elementName is null or is not a legal element name for this format.

public String getElementDescription (String elementName, Locale locale)

Returns a String containing a description of the named element, or null.

Returns a String containing a description of the named element, or null. The desciption will be localized for the supplied Locale if possible.

If locale is null, the current default Locale returned by Locale.getLocale will be used.
Returns: the element description.
Parameters:
- elementName - the name of the element.
- locale - the Locale for which localization will be attempted.
Throws:
- IllegalArgumentException - if elementName is null, or is not a legal element name for this format.

public int getElementMaxChildren (String elementName)

Returns the maximum number of children of the named element with child policy CHILD_POLICY_REPEAT.

Returns the maximum number of children of the named element
with child policy CHILD_POLICY_REPEAT. For
example, an element representing an entry in an 8-bit color
palette might be allowed to repeat up to 256 times. A value of
Integer.MAX_VALUE may be used to specify that
there is no upper bound.
Returns: an int.
Parameters:
- elementName - the name of the element being queried.
Throws:
- IllegalArgumentException - if elementName is null or is not a legal element name for this format.
- IllegalArgumentException - if the named element does not have a child policy of CHILD_POLICY_REPEAT.

public int getElementMinChildren (String elementName)

Returns the minimum number of children of the named element with child policy CHILD_POLICY_REPEAT.

Returns the minimum number of children of the named element
with child policy CHILD_POLICY_REPEAT. For
example, an element representing color primary information
might be required to have at least 3 children, one for each
primay.
Returns: an int.
Parameters:
- elementName - the name of the element being queried.
Throws:
- IllegalArgumentException - if elementName is null or is not a legal element name for this format.
- IllegalArgumentException - if the named element does not have a child policy of CHILD_POLICY_REPEAT.

public int getObjectArrayMaxLength (String elementName)

Returns the maximum number of array elements that may be used to define the Object reference within the named element.

Returns the maximum number of array elements that may be used
to define the Object reference within the named
element. A value of Integer.MAX_VALUE may be used
to specify that there is no upper bound. This method should
only be called if getObjectValueType returns
VALUE_LIST.
Returns: the largest valid array length for the Object reference.
Parameters:
- elementName - the name of the element being queried.
Throws:
- IllegalArgumentException - if elementName is null or is not a legal element name for this format.
- IllegalArgumentException - if the named element cannot contain an object value (i.e., if getObjectValueType(elementName) == VALUE_NONE).
- IllegalArgumentException - if the Object is not an array.

public int getObjectArrayMinLength (String elementName)

Returns the minimum number of array elements that may be used to define the Object reference within the named element.

Returns the minimum number of array elements that may be used
to define the Object reference within the named
element. This method should only be called if
getObjectValueType returns
VALUE_LIST.
Returns: the smallest valid array length for the Object reference.
Parameters:
- elementName - the name of the element being queried.
Throws:
- IllegalArgumentException - if elementName is null or is not a legal element name for this format.
- IllegalArgumentException - if the named element cannot contain an object value (i.e., if getObjectValueType(elementName) == VALUE_NONE).
- IllegalArgumentException - if the Object is not an array.

public Class<Object> getObjectClass (String elementName)

Returns the Class type of the Object reference stored within the element.

Returns the Class type of the Object reference stored within the element. If this element may not contain an Object reference, an IllegalArgumentException will be thrown. If the class type is an array, this field indicates the underlying class type (e.g, for an array of ints, this method would return int.class).

Object references whose legal values are defined as a range must implement the Comparable interface.
Returns: a Class object.
Parameters:
- elementName - the name of the element being queried.
Throws:
- IllegalArgumentException - if elementName is null or is not a legal element name for this format.
- IllegalArgumentException - if the named element cannot contain an object value (i.e., if getObjectValueType(elementName) == VALUE_NONE).

public Object getObjectDefaultValue (String elementName)

Returns an Objects containing the default value for the Object reference within the named element.

Returns an Objects containing the default
value for the Object reference within
the named element.
Returns: an Object.
Parameters:
- elementName - the name of the element being queried.
Throws:
- IllegalArgumentException - if elementName is null or is not a legal element name for this format.
- IllegalArgumentException - if the named element cannot contain an object value (i.e., if getObjectValueType(elementName) == VALUE_NONE).

public Object getObjectEnumerations (String elementName)

Returns an array of Objects containing the legal enumerated values for the Object reference within the named element.

Returns an array of Objects containing the legal enumerated values for the Object reference within the named element. This method should only be called if getObjectValueType returns VALUE_ENUMERATION.

The Object associated with a node that accepts emuerated values must be equal to one of the values returned by this method, as defined by the == operator (as opposed to the Object.equals method).
Returns: an array of Objects.
Parameters:
- elementName - the name of the element being queried.
Throws:
- IllegalArgumentException - if elementName is null or is not a legal element name for this format.
- IllegalArgumentException - if the named element cannot contain an object value (i.e., if getObjectValueType(elementName) == VALUE_NONE).
- IllegalArgumentException - if the Object is not defined as an enumeration.

public Comparable<Object> getObjectMaxValue (String elementName)

Returns the maximum legal value for the Object reference within the named element.

Returns the maximum legal value for the Object
reference within the named element. Whether this value is
inclusive or exclusive may be determined by the value of
getObjectValueType. This method should only be
called if getObjectValueType returns one of the
constants starting with VALUE_RANGE.
Returns: the smallest legal value for the attribute.
Parameters:
- elementName - the name of the element being queried.
Throws:
- IllegalArgumentException - if elementName is null or is not a legal element name for this format.
- IllegalArgumentException - if the named element cannot contain an object value (i.e., if getObjectValueType(elementName) == VALUE_NONE).
- IllegalArgumentException - if the Object is not defined as a range.

public Comparable<Object> getObjectMinValue (String elementName)

Returns the minimum legal value for the Object reference within the named element.

Returns the minimum legal value for the Object
reference within the named element. Whether this value is
inclusive or exclusive may be determined by the value of
getObjectValueType. This method should only be
called if getObjectValueType returns one of the
constants starting with VALUE_RANGE.
Returns: the smallest legal value for the attribute.
Parameters:
- elementName - the name of the element being queried.
Throws:
- IllegalArgumentException - if elementName is null or is not a legal element name for this format.
- IllegalArgumentException - if the named element cannot contain an object value (i.e., if getObjectValueType(elementName) == VALUE_NONE).
- IllegalArgumentException - if the Object is not defined as a range.

public int getObjectValueType (String elementName)

Returns one of the enumerated values starting with VALUE_, indicating the type of values (enumeration, range, or array) that are allowed for the Object reference.

Returns one of the enumerated values starting with VALUE_, indicating the type of values (enumeration, range, or array) that are allowed for the Object reference. If no object value can be stored within the given element, the result of this method will be VALUE_NONE.

Object references whose legal values are defined as a range must implement the Comparable interface.
Returns: one of the VALUE_* constants.
Parameters:
- elementName - the name of the element being queried.
Throws:
- IllegalArgumentException - if elementName is null or is not a legal element name for this format.
See Also: Comparable,

public String getRootName ()

Returns the name of the root element of the format.

Returns the name of the root element of the format.
Returns: a String.

public boolean isAttributeRequired (String elementName, String attrName)

Returns true if the named attribute must be present within the named element.

Returns true if the named attribute must be
present within the named element.
Returns: true if the attribut must be present.
Parameters:
- elementName - the name of the element being queried.
- attrName - the name of the attribute being queried.
Throws:
- IllegalArgumentException - if elementName is null or is not a legal element name for this format.
- IllegalArgumentException - if attrName is null or is not a legal attribute name for this element.

Fields

Hide/Show inherited fields

publicfinalstatic int CHILD_POLICY_ALL = "1"

A constant returned by getChildPolicy to indicate that an element must have a single instance of each of its legal child elements, in order.

A constant returned by getChildPolicy to indicate
that an element must have a single instance of each of its
legal child elements, in order. In DTD terms, the contents of
the element are defined by a sequence a,b,c,d,....

publicfinalstatic int CHILD_POLICY_CHOICE = "3"

A constant returned by getChildPolicy to indicate that an element must have zero or one children, selected from among its legal child elements.

A constant returned by getChildPolicy to indicate
that an element must have zero or one children, selected from
among its legal child elements. In DTD terms, the contents of
the element are defined by a selection
a|b|c|d|....

publicfinalstatic int CHILD_POLICY_EMPTY = "0"

A constant returned by getChildPolicy to indicate that an element may not have any children.

A constant returned by getChildPolicy to indicate
that an element may not have any children. In other words, it
is required to be a leaf node.

publicfinalstatic int CHILD_POLICY_MAX = "5"

The largest valid CHILD_POLICY_* constant, to be used for range checks.

publicfinalstatic int CHILD_POLICY_REPEAT = "5"

A constant returned by getChildPolicy to indicate that an element must have zero or more instances of its unique legal child element.

A constant returned by getChildPolicy to indicate
that an element must have zero or more instances of its unique
legal child element. In DTD terms, the contents of the element
are defined by a starred expression a*.

publicfinalstatic int CHILD_POLICY_SEQUENCE = "4"

A constant returned by getChildPolicy to indicate that an element must have a sequence of instances of any of its legal child elements.

A constant returned by getChildPolicy to indicate
that an element must have a sequence of instances of any of its
legal child elements. In DTD terms, the contents of the
element are defined by a sequence (a|b|c|d|...)*.

publicfinalstatic int CHILD_POLICY_SOME = "2"

A constant returned by getChildPolicy to indicate that an element must have zero or one instance of each of its legal child elements, in order.

A constant returned by getChildPolicy to indicate
that an element must have zero or one instance of each of its
legal child elements, in order. In DTD terms, the contents of
the element are defined by a sequence
a?,b?,c?,d?,....

publicfinalstatic int DATATYPE_BOOLEAN = "1"

A constant returned by getAttributeDataType indicating that the value of an attribute is one of 'true' or 'false'.

publicfinalstatic int DATATYPE_DOUBLE = "4"

A constant returned by getAttributeDataType indicating that the value of an attribute is a string representation of a double-precision decimal floating-point number.

publicfinalstatic int DATATYPE_FLOAT = "3"

A constant returned by getAttributeDataType indicating that the value of an attribute is a string representation of a decimal floating-point number.

publicfinalstatic int DATATYPE_INTEGER = "2"

A constant returned by getAttributeDataType indicating that the value of an attribute is a string representation of an integer.

publicfinalstatic int DATATYPE_STRING = "0"

A constant returned by getAttributeDataType indicating that the value of an attribute is a general Unicode string.

publicfinalstatic int VALUE_ARBITRARY = "1"

A constant returned by getAttributeValueType and getObjectValueType to indicate that the attribute or user object may be set a single, arbitrary value.

publicfinalstatic int VALUE_ENUMERATION = "16"

A constant returned by getAttributeValueType and getObjectValueType to indicate that the attribute or user object may be set one of a number of enumerated values.

A constant returned by getAttributeValueType and getObjectValueType to indicate that the attribute or user object may be set one of a number of enumerated values. In the case of attributes, these values are Strings; for objects, they are Objects implementing a given class or interface.

Attribute values of type DATATYPE_BOOLEAN should be marked as enumerations.

publicfinalstatic int VALUE_LIST = "32"

A constant returned by getAttributeValueType and getObjectValueType to indicate that the attribute or user object may be set to a list or array of values.

A constant returned by getAttributeValueType and
getObjectValueType to indicate that the attribute
or user object may be set to a list or array of values. In the
case of attributes, the list will consist of
whitespace-separated values within a String; for
objects, an array will be used.

publicfinalstatic int VALUE_NONE = "0"

A constant returned by getObjectValueType to indicate the absence of a user object.

publicfinalstatic int VALUE_RANGE = "2"

A constant returned by getAttributeValueType and getObjectValueType to indicate that the attribute or user object may be set a range of values.

A constant returned by getAttributeValueType and
getObjectValueType to indicate that the attribute
or user object may be set a range of values. Both the minimum
and maximum values of the range are exclusive. It is
recommended that ranges of integers be inclusive on both ends,
and that exclusive ranges be used only for floating-point data.
See Also: IIOMetadataFormat.VALUE_RANGE_MIN_MAX_INCLUSIVE,

publicfinalstatic int VALUE_RANGE_MAX_INCLUSIVE = "10"

A constant returned by getAttributeValueType and getObjectValueType to indicate that the attribute or user object may be set to a range of values.

A constant returned by getAttributeValueType and
getObjectValueType to indicate that the attribute
or user object may be set to a range of values. The maximum
(but not the minimum) value of the range is inclusive.

publicfinalstatic int VALUE_RANGE_MAX_INCLUSIVE_MASK = "8"

A value that may be or'ed with VALUE_RANGE to obtain VALUE_RANGE_MAX_INCLUSIVE, and with VALUE_RANGE_MIN_INCLUSIVE to obtain VALUE_RANGE_MIN_MAX_INCLUSIVE.

Similarly, the value may be and'ed with the value of getAttributeValueTypeor getObjectValueType to determine if the maximum value of the range is inclusive.

publicfinalstatic int VALUE_RANGE_MIN_INCLUSIVE = "6"

A constant returned by getAttributeValueType and getObjectValueType to indicate that the attribute or user object may be set to a range of values.

A constant returned by getAttributeValueType and
getObjectValueType to indicate that the attribute
or user object may be set to a range of values. The minimum
(but not the maximum) value of the range is inclusive.

publicfinalstatic int VALUE_RANGE_MIN_INCLUSIVE_MASK = "4"

A value that may be or'ed with VALUE_RANGE to obtain VALUE_RANGE_MIN_INCLUSIVE, and with VALUE_RANGE_MAX_INCLUSIVE to obtain VALUE_RANGE_MIN_MAX_INCLUSIVE.

Similarly, the value may be and'ed with the value of getAttributeValueTypeor getObjectValueType to determine if the minimum value of the range is inclusive.

publicfinalstatic int VALUE_RANGE_MIN_MAX_INCLUSIVE = "14"

A constant returned by getAttributeValueType and getObjectValueType to indicate that the attribute or user object may be set a range of values.

A constant returned by getAttributeValueType and
getObjectValueType to indicate that the attribute
or user object may be set a range of values. Both the minimum
and maximum values of the range are inclusive. It is
recommended that ranges of integers be inclusive on both ends,
and that exclusive ranges be used only for floating-point data.