IIOMetadata JDK 1.6)

public boolean activateController ()

Activates the installed IIOMetadataController for this IIOMetadata object and returns the resulting value.

Activates the installed IIOMetadataController for this IIOMetadata object and returns the resulting value. When this method returns true, all values for this IIOMetadata object will be ready for the next write operation. If false is returned, no settings in this object will have been disturbed (i.e., the user canceled the operation).

Ordinarily, the controller will be a GUI providing a user interface for a subclass of IIOMetadata for a particular plug-in. Controllers need not be GUIs, however.

The default implementation calls getController and the calls activate on the returned object if hasController returns true.
Returns: true if the controller completed normally.
Throws:
- IllegalStateException - if there is no controller currently installed.
See Also: IIOMetadataController, IIOMetadata.setController(IIOMetadataController), IIOMetadata.getController(), IIOMetadata.getDefaultController(), IIOMetadata.hasController(),

publicabstract Node getAsTree (String formatName)

Returns an XML DOM Node object that represents the root of a tree of metadata contained within this object according to the conventions defined by a given metadata format.

The names of the available metadata formats may be queried using the getMetadataFormatNames method.
Returns: an XML DOM Node object forming the root of a tree.
Parameters:
- formatName - the desired metadata format.
Throws:
- IllegalArgumentException - if formatName is null or is not one of the names returned by getMetadataFormatNames.
See Also: IIOMetadata.getMetadataFormatNames(), IIOMetadata.setFromTree(java.lang.String, org.w3c.dom.Node), IIOMetadata.mergeTree(java.lang.String, org.w3c.dom.Node),

public IIOMetadataController getController ()

Returns whatever IIOMetadataController is currently installed.

Returns whatever IIOMetadataController is currently installed. This could be the default if there is one, null, or the argument of the most recent call to setController.

The default implementation returns the value of the controller instance variable.
Returns: the currently installed IIOMetadataController, or null.
See Also: IIOMetadataController, IIOMetadata.setController(javax.imageio.metadata.IIOMetadataController), IIOMetadata.getDefaultController(), IIOMetadata.hasController(), IIOMetadata.activateController(),

public IIOMetadataController getDefaultController ()

Returns the default IIOMetadataController, if there is one, regardless of the currently installed controller.

Returns the default IIOMetadataController, if there is one, regardless of the currently installed controller. If there is no default controller, returns null.

The default implementation returns the value of the defaultController instance variable.
Returns: the default IIOMetadataController, or null.
See Also: IIOMetadataController, IIOMetadata.setController(IIOMetadataController), IIOMetadata.getController(), IIOMetadata.hasController(), IIOMetadata.activateController(),

public String getExtraMetadataFormatNames ()

Returns an array of Strings containing the names of additional metadata formats, other than the native and standard formats, recognized by this plug-in's getAsTree, setFromTree, and mergeTree methods.

Returns an array of Strings containing the names of additional metadata formats, other than the native and standard formats, recognized by this plug-in's getAsTree, setFromTree, and mergeTree methods. If there are no such additional formats, null is returned.

The default implementation returns a clone of the extraMetadataFormatNames instance variable.
Returns: an array of Strings with length at least 1, or null.
See Also: IIOMetadata.getAsTree(java.lang.String), IIOMetadata.setFromTree(java.lang.String, org.w3c.dom.Node), IIOMetadata.mergeTree(java.lang.String, org.w3c.dom.Node), IIOMetadata.getNativeMetadataFormatName(), IIOMetadata.getMetadataFormatNames(),

public IIOMetadataFormat getMetadataFormat (String formatName)

Returns an IIOMetadataFormat object describing the given metadata format, or null if no description is available.

Returns an IIOMetadataFormat object describing the given metadata format, or null if no description is available. The supplied name must be one of those returned by getMetadataFormatNames (i.e., either the native format name, the standard format name, or one of those returned by getExtraMetadataFormatNames).

The default implementation checks the name against the global standard metadata format name, and returns that format if it is supported. Otherwise, it checks against the native format names followed by any additional format names. If a match is found, it retrieves the name of the IIOMetadataFormat class from nativeMetadataFormatClassName or extraMetadataFormatClassNames as appropriate, and constructs an instance of that class using its getInstance method.
Returns: an IIOMetadataFormat object.
Parameters:
- formatName - the desired metadata format.
Throws:
- IllegalArgumentException - if formatName is null or is not one of the names recognized by the plug-in.
- IllegalStateException - if the class corresponding to the format name cannot be loaded.

public String getMetadataFormatNames ()

Returns an array of Strings containing the names of all metadata formats, including the native and standard formats, recognized by this plug-in's getAsTree, setFromTree, and mergeTree methods.

Returns an array of Strings containing the names of all metadata formats, including the native and standard formats, recognized by this plug-in's getAsTree, setFromTree, and mergeTree methods. If there are no such formats, null is returned.

The default implementation calls getNativeMetadataFormatName, isStandardMetadataFormatSupported, and getExtraMetadataFormatNames and returns the combined results.
Returns: an array of Strings.
See Also: IIOMetadata.getNativeMetadataFormatName(), IIOMetadata.isStandardMetadataFormatSupported(), IIOMetadata.getExtraMetadataFormatNames(),

public String getNativeMetadataFormatName ()

Returns the name of the "native" metadata format for this plug-in, which typically allows for lossless encoding and transmission of the metadata stored in the format handled by this plug-in.

Returns the name of the "native" metadata format for this plug-in, which typically allows for lossless encoding and transmission of the metadata stored in the format handled by this plug-in. If no such format is supported, nullwill be returned.

The structure and contents of the "native" metadata format are defined by the plug-in that created this IIOMetadata object. Plug-ins for simple formats will usually create a dummy node for the root, and then a series of child nodes representing individual tags, chunks, or keyword/value pairs. A plug-in may choose whether or not to document its native format.

The default implementation returns the value of the nativeMetadataFormatName instance variable.
Returns: the name of the native format, or null.
See Also: IIOMetadata.getExtraMetadataFormatNames(), IIOMetadata.getMetadataFormatNames(),

protected IIOMetadataNode getStandardChromaNode ()

Returns an IIOMetadataNode representing the chroma information of the standard javax_imageio_1.0 metadata format, or null if no such information is available.

Returns an IIOMetadataNode representing the chroma information of the standard javax_imageio_1.0 metadata format, or null if no such information is available. This method is intended to be called by the utility routine getStandardTree.