org.dcm4che.imageio.plugins
Class DcmMetadata

java.lang.Object
  javax.imageio.metadata.IIOMetadata
      org.dcm4che.imageio.plugins.DcmMetadata

public abstract class DcmMetadata
extends javax.imageio.metadata.IIOMetadata

ImageIO Meta Data for DICOM image. Change history:
2002.06.13, Thomas Hacklaender: Method setDataset(Dataset ds) added.
2002.06.16, Thomas Hacklaender: Methods reset(), setFromTree(String formatName, Node root) and mergeTree(String formatName, Node root) added. Method isReadOnly() modified.

Version:

2002.06.13

Author:

gunter.zeilinger@tiani.com, Thomas Hacklaender

Field Summary

static java.lang.String

nativeMetadataFormatName

Fields inherited from class javax.imageio.metadata.IIOMetadata

controller, defaultController, extraMetadataFormatClassNames, extraMetadataFormatNames, nativeMetadataFormatClassName, standardFormatSupported

Constructor Summary

protected

DcmMetadata(boolean standardMetadataFormatSupported, java.lang.String[] extraMetadataFormatNames, java.lang.String[] extraMetadataFormatClassNames)

Method Summary

abstract Dataset	getDataset()
abstract void	mergeTree(java.lang.String formatName, org.w3c.dom.Node root) Alters the internal state of this IIOMetadata object from a tree of XML DOM Nodes whose syntax is defined by the given metadata format.
abstract void	reset() Resets all the data stored in this object to default values to the state this object was in immediately after construction.
abstract void	setDataset(Dataset ds) Sets a new Dataset as a base for the metadata.
abstract void	setDictionary(TagDictionary dict)
abstract void	setFromTree(java.lang.String formatName, org.w3c.dom.Node root) Sets the internal state of this IIOMetadata object from a tree of XML DOM Nodes whose syntax is defined by the given metadata format.

Methods inherited from class javax.imageio.metadata.IIOMetadata

activateController, getAsTree, getController, getDefaultController, getExtraMetadataFormatNames, getMetadataFormat, getMetadataFormatNames, getNativeMetadataFormatName, getStandardChromaNode, getStandardCompressionNode, getStandardDataNode, getStandardDimensionNode, getStandardDocumentNode, getStandardTextNode, getStandardTileNode, getStandardTransparencyNode, getStandardTree, hasController, isReadOnly, isStandardMetadataFormatSupported, setController

Methods inherited from class java.lang.Object

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

Field Detail

nativeMetadataFormatName

public static final java.lang.String nativeMetadataFormatName

See Also:

Constant Field Values

Constructor Detail

DcmMetadata

protected DcmMetadata(boolean standardMetadataFormatSupported,
                      java.lang.String[] extraMetadataFormatNames,
                      java.lang.String[] extraMetadataFormatClassNames)

Method Detail

getDataset

public abstract Dataset getDataset()

setDataset

public abstract void setDataset(Dataset ds)

Sets a new Dataset as a base for the metadata.

Parameters:

ds - the new Dataset.

setDictionary

public abstract void setDictionary(TagDictionary dict)

setFromTree

public abstract void setFromTree(java.lang.String formatName,
                                 org.w3c.dom.Node root)

Sets the internal state of this IIOMetadata object from a tree of XML DOM Nodes whose syntax is defined by the given metadata format. The previous state is discarded. If the tree's structure or contents are invalid, an IIOInvalidTreeException will be thrown.

Overrides:

setFromTree in class javax.imageio.metadata.IIOMetadata

Parameters:

formatName - the desired metadata format.

root - an XML DOM Node object forming the root of a tree.

Throws:

java.lang.IllegalStateException - if this object is read-only.

java.lang.IllegalArgumentException - if formatName is null or is not one of the names returned by getMetadataFormatNames.

IIOInvalidTreeException - if the tree cannot be parsed successfully using the rules of the given format.

mergeTree

public abstract void mergeTree(java.lang.String formatName,
                               org.w3c.dom.Node root)

Alters the internal state of this IIOMetadata object from a tree of XML DOM Nodes whose syntax is defined by the given metadata format. The previous state is altered only as necessary to accomodate the nodes that are present in the given tree. If the tree structure or contents are invalid, an IIOInvalidTreeException will be thrown.

Specified by:

mergeTree in class javax.imageio.metadata.IIOMetadata

Parameters:

formatName - the desired metadata format.

root - an XML DOM Node object forming the root of a tree.

Throws:

java.lang.IllegalStateException - if this object is read-only.

java.lang.IllegalArgumentException - if formatName is null or is not one of the names returned by getMetadataFormatNames.

IIOInvalidTreeException - if the tree cannot be parsed successfully using the rules of the given format.

reset

public abstract void reset()

Resets all the data stored in this object to default values to the state this object was in immediately after construction.

Specified by:

reset in class javax.imageio.metadata.IIOMetadata

Since:

1.0.0