edu.harvard.hul.ois.jhove.module.jpeg2000

Class LabelBox

java.lang.Object

edu.harvard.hul.ois.jhove.module.jpeg2000.BoxHolder

edu.harvard.hul.ois.jhove.module.jpeg2000.JP2Box

edu.harvard.hul.ois.jhove.module.jpeg2000.LabelBox

All Implemented Interfaces:

Iterator<Object>

public class LabelBox
extends JP2Box

Label box. A Label box does nothing in itself; it simply makes its label string available for its superbox. See ISO/IEC FCD15444-2: 2000, L.9.13

Author:

Gary McGath

Property Summary

Properties inherited from class edu.harvard.hul.ois.jhove.module.jpeg2000.JP2Box

makeAssocProperty, selfDescProperty

Field Summary

Fields inherited from class edu.harvard.hul.ois.jhove.module.jpeg2000.JP2Box

_bytesRead, associations, DESCRIPTION_NAME, noJP2Hdr, startBytesRead

Fields inherited from class edu.harvard.hul.ois.jhove.module.jpeg2000.BoxHolder

_boxHeader, _dstrm, _module, _parentBox, _raf, _repInfo, bytesLeft, filePos, hasBoxes

Constructor Summary

Constructors

Constructor and Description
LabelBox(RandomAccessFile raf, BoxHolder parent) Constructor with superbox.

Method Summary

Modifier and Type	Method and Description
protected String	getLabel() Returns the label string.
protected Property	getSelfPropDesc() Returns a Property which describes the Box, for use by Association boxes and perhaps others.
protected String	getSelfPropName() Returns the name of the Box.
boolean	readBox() Reads the box, saving the label text.

Methods inherited from class edu.harvard.hul.ois.jhove.module.jpeg2000.JP2Box

addAssociation, boxMaker, emptyBox, finalizeBytesRead, getBytesRead, getLength, init, initBytesRead, makeAssocProperty, selfDescProperty, setBoxHeader, setDataInputStream, setModule, setRandomAccessFile, setRepInfo, skipBox, wrongBoxContext, wrongBoxSize

Methods inherited from class edu.harvard.hul.ois.jhove.module.jpeg2000.BoxHolder

getFilePos, hasNext, next, remove, superboxOverrun, superboxUnderrun

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

LabelBox

public LabelBox(RandomAccessFile raf,
                BoxHolder parent)

Constructor with superbox.

Parameters:

parent - parent superbox of this box

Method Detail

readBox

public boolean readBox()
                throws IOException

Reads the box, saving the label text. setModule, setBoxHeader, setRepInfo and setDataInputStream must be called before readBox is called. readBox must completely consume the box, so that the next byte to be read by the DataInputStream is the FF byte of the next Box.

Specified by:

readBox in class JP2Box

Throws:

IOException

getLabel

protected String getLabel()

Returns the label string. Valid only after readBox() has been called.

getSelfPropDesc

protected Property getSelfPropDesc()

Returns a Property which describes the Box, for use by Association boxes and perhaps others.

Overrides:

getSelfPropDesc in class JP2Box

getSelfPropName

protected String getSelfPropName()

Returns the name of the Box.

Overrides:

getSelfPropName in class JP2Box