Class PNMMetadata

java.lang.Object

javax.imageio.metadata.IIOMetadata

com.github.jaiimageio.impl.plugins.pnm.PNMMetadata

All Implemented Interfaces:

Cloneable

public class PNMMetadata
extends IIOMetadata
implements Cloneable

Metadata for the PNM plug-in.

Field Summary

Fields

Modifier and Type	Field	Description
private ArrayList	comments	The comments.
private int	height	The image height.
private int	maxSample	The max value for the encoded/decoded image.
private int	maxSampleSize	Maximum number of bits per sample (not in metadata).
(package private) static final String	nativeMetadataFormatName
private int	variant	The image variants.
private int	width	The image width.

Fields inherited from class IIOMetadata

controller, defaultController, extraMetadataFormatClassNames, extraMetadataFormatNames, nativeMetadataFormatClassName, standardFormatSupported

Constructor Summary

Constructors

Constructor	Description
PNMMetadata()	Constructor containing code shared by other constructors.
PNMMetadata(ImageTypeSpecifier imageType, ImageWriteParam param)	Constructs a default image PNMMetadata object appropriate for the given image type and write parameters.
PNMMetadata(IIOMetadata metadata)

Method Summary

Modifier and Type	Method	Description
void	addComment(String comment)
protected Object	clone()
Node	getAsTree(String formatName)
Object	getAttribute(Node node, String name)
(package private) Iterator	getComments()
String	getFormatName()
(package private) int	getMaxBitDepth()
(package private) int	getMaxValue()
(package private) IIOMetadataNode	getNativeTree()
protected IIOMetadataNode	getStandardChromaNode()
protected IIOMetadataNode	getStandardDataNode()
protected IIOMetadataNode	getStandardDimensionNode()
protected IIOMetadataNode	getStandardTextNode()
String	getVariant()
(package private) void	initialize(ImageTypeSpecifier imageType, ImageWriteParam param)
(package private) boolean	isRaw()
boolean	isReadOnly()
private void	mergeNativeTree(Node root)
private void	mergeStandardTree(Node root)
void	mergeTree(String formatName, Node root)
void	reset()
void	setFromTree(String formatName, Node root)
void	setHeight(int h)
void	setMaxBitDepth(int maxValue)	Set the maximum sample size and maximum sample value.
void	setVariant(int v)	Sets the variant: '1' - '6'.
void	setWidth(int w)

Methods inherited from class IIOMetadata

activateController, getController, getDefaultController, getExtraMetadataFormatNames, getMetadataFormat, getMetadataFormatNames, getNativeMetadataFormatName, getStandardCompressionNode, getStandardDocumentNode, getStandardTileNode, getStandardTransparencyNode, getStandardTree, hasController, isStandardMetadataFormatSupported, setController

Methods inherited from class Object

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

Field Details

nativeMetadataFormatName

static final String nativeMetadataFormatName

See Also:

• Constant Field Values

maxSample

private int maxSample

The max value for the encoded/decoded image.

width

private int width

The image width.

height

private int height

The image height.

variant

private int variant

The image variants.

comments

private ArrayList comments

The comments.

maxSampleSize

private int maxSampleSize

Maximum number of bits per sample (not in metadata).

Constructor Details

PNMMetadata

PNMMetadata()

Constructor containing code shared by other constructors.

PNMMetadata

public PNMMetadata(IIOMetadata metadata)
            throws IIOInvalidTreeException

Throws:

IIOInvalidTreeException

PNMMetadata

PNMMetadata(ImageTypeSpecifier imageType,
 ImageWriteParam param)

Constructs a default image PNMMetadata object appropriate for the given image type and write parameters.

Method Details

initialize

void initialize(ImageTypeSpecifier imageType,
 ImageWriteParam param)

clone

protected Object clone()

Overrides:

clone in class Object

getAsTree

public Node getAsTree(String formatName)

Specified by:

getAsTree in class IIOMetadata

getNativeTree

IIOMetadataNode getNativeTree()

getStandardChromaNode

protected IIOMetadataNode getStandardChromaNode()

Overrides:

getStandardChromaNode in class IIOMetadata

getStandardDataNode

protected IIOMetadataNode getStandardDataNode()

Overrides:

getStandardDataNode in class IIOMetadata

getStandardDimensionNode

protected IIOMetadataNode getStandardDimensionNode()

Overrides:

getStandardDimensionNode in class IIOMetadata

getStandardTextNode

protected IIOMetadataNode getStandardTextNode()

Overrides:

getStandardTextNode in class IIOMetadata

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in class IIOMetadata

mergeTree

public void mergeTree(String formatName,
 Node root)
               throws IIOInvalidTreeException

Specified by:

mergeTree in class IIOMetadata

Throws:

IIOInvalidTreeException

setFromTree

public void setFromTree(String formatName,
 Node root)
                 throws IIOInvalidTreeException

Overrides:

setFromTree in class IIOMetadata

Throws:

IIOInvalidTreeException

reset

public void reset()

Specified by:

reset in class IIOMetadata

getFormatName

public String getFormatName()

getVariant

public String getVariant()

isRaw

boolean isRaw()

setVariant

public void setVariant(int v)

Sets the variant: '1' - '6'.

setWidth

public void setWidth(int w)

setHeight

public void setHeight(int h)

getMaxBitDepth

int getMaxBitDepth()

getMaxValue

int getMaxValue()

setMaxBitDepth

public void setMaxBitDepth(int maxValue)

Set the maximum sample size and maximum sample value.

Parameters:

maxValue - The maximum sample value. This method computes the maximum sample size.

addComment

public void addComment(String comment)

getComments

Iterator getComments()

mergeNativeTree

private void mergeNativeTree(Node root)
                      throws IIOInvalidTreeException

Throws:

IIOInvalidTreeException

mergeStandardTree

private void mergeStandardTree(Node root)
                        throws IIOInvalidTreeException

Throws:

IIOInvalidTreeException

getAttribute

public Object getAttribute(Node node,
 String name)