Property Detail

• makeAssoc

  protected Property makeAssocProperty

  Make a Property from the association list. Returns null if the list is empty.

• selfDesc

  protected Property selfDescProperty

  Returns a Property which describes the Box, for use by Association boxes and perhaps others. Most subclasses will only have to override getSelfPropName and getSelfPropDesc. A subclass that shouldn't be added to the Association box's property can override this to return null.

Field Detail

• startBytesRead

  protected long startBytesRead

• _bytesRead

  protected long _bytesRead

• associations

  protected List<Property> associations

• noJP2Hdr

  protected static final String noJP2Hdr

  See Also:

  Constant Field Values

• DESCRIPTION_NAME

  protected static final String DESCRIPTION_NAME

  See Also:

  Constant Field Values

Constructor Detail

• JP2Box

  public JP2Box(RandomAccessFile raf)

  Constructor. Has no arguments, so that invoking lots of different subclasses is relatively simple. setModule, setBoxHeader, setRepInfo, and setDataInputStream should be called immediately after the constructor.

• JP2Box

  public JP2Box(RandomAccessFile raf,
                BoxHolder parent)

  Constructor for a box which is found within a superbox.

  Parameters:

  parent - parent superbox of this box

Method Detail

• init

  protected void init(BoxHolder parent)

• setModule

  public void setModule(Jpeg2000Module module)

  Sets the module under which the Box is being read.

• setBoxHeader

  public void setBoxHeader(BoxHeader hdr)

  Sets the BoxHeader from which this Box was obtained.

• setRepInfo

  public void setRepInfo(RepInfo info)

  Assigns a RepInfo object, so that subclasses of JP2Box can add Properties and Messages.

• setDataInputStream

  public void setDataInputStream(DataInputStream dstrm)

  Assigns the DataInputStream from which the box is being read.

• setRandomAccessFile

  public void setRandomAccessFile(RandomAccessFile raf)

  Assigns the RandomAccessFile from which the box is being read.

• boxMaker

  public static JP2Box boxMaker(String hType,
                                BoxHolder parent)

  Static factory method for generating an object of the appropriate subclass of MarkerSegment, based on the box type. This is for use in top-level reading of boxes, not subboxes. Provision is made for calling this with a parent box, but the set of boxes dispatched on is the set used at top level. Certain box types have magical characteristics and have to be checked by the BoxHolder. These include BinaryFilterBox and CrossReferenceBox.

  Parameters:

  hType - 4-character string indicating the box type

  parent - parent BoxHolder

• initBytesRead

  protected void initBytesRead()

• finalizeBytesRead

  protected void finalizeBytesRead()

• readBox

  public abstract boolean readBox()
                           throws IOException

  Reads the box, putting appropriate information in the RepInfo object. setModule, setBoxHeader, setRepInfo and setDataInputStream must be called before readBox is called. Thus, the header of the box must already have been read. 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. The number of bytes read must be placed in _bytesRead.

  Throws:

  IOException

• getBytesRead

  public int getBytesRead()

• skipBox

  public void skipBox()
               throws IOException

  Skips over the box. Can be called when the box is legal but meaningless in the current context.

  Throws:

  IOException

• addAssociation

  protected void addAssociation(Property p)

• wrongBoxSize

  protected void wrongBoxSize()

  Utility error reporting function for incorrect box length. Sets the RepInfo's wellFormed flag to false.

• wrongBoxContext

  protected void wrongBoxContext()

  Utility error reporting function for box in a context (superbox or lack thereof) which is not permitted. Sets the RepInfo's wellFormed flag to false.

• emptyBox

  protected void emptyBox()

  Utility error reporting function for a box which is expected to have subboxes, but doesn't.

• makeAssocProperty

  protected Property makeAssocProperty()

  Make a Property from the association list. Returns null if the list is empty.

• selfDescProperty

  protected Property selfDescProperty()

  Returns a Property which describes the Box, for use by Association boxes and perhaps others. Most subclasses will only have to override getSelfPropName and getSelfPropDesc. A subclass that shouldn't be added to the Association box's property can override this to return null.

• getSelfPropName

  protected String getSelfPropName()

  Returns the name of the Box. All Boxes should override this.

  Overrides:

  getSelfPropName in class BoxHolder

• getSelfPropDesc

  protected Property getSelfPropDesc()

  Returns a Property which describes the box. This is used as a subproperty of the Property returned by selfDescProperty. Properties that we don't care to describe don't have to override this. This class should return either null or a property with DESCRIPTION_NAME for its name.

• getLength

  protected long getLength()

  Returns the length of the box, including header, based on the information in the header.