NumberTree Class Documentation

class NumberTree

Namespace:com::datalogics::PDFL

Detailed Description

The number tree is a common data structure in PDF files. The number tree is a type of dictionary that can store many more pairs of matched records than a standard object dictionary.

A number tree uses keys that are integers to map to data objects, sorted in ascending numerical order.

Referenced by

DocumentNumberTree

Constructor & Destructor Documentation

NumberTree

NumberTree(Document doc)

Parameters

doc: Document

The Document in which to create the NumberTree.

Creates a new, empty NumberTree in the specified Document.

Member Function Documentation

delete

synchronized void delete(Boolean disposing)

Parameters

disposing: Boolean

Returns:

synchronized void

delete

synchronized void delete()

Returns:

synchronized void

equals

boolean equals(Object rhs)

Parameters

rhs: Object

Returns:

boolean

finalize

void finalize()

Returns:

void

get

PDFObject get(int key)

Parameters

key: int

The integer key of the PDFObject to get from the tree.

Returns:

PDFObject

The PDFObject value corresponding to the supplied key.

Retrieves an entry from this NumberTree.

getPDFDict

PDFDict getPDFDict()

Returns:

PDFDict

The PDFDict representing the NumberTree's data structure.

Gets the underlying PDFDict of this NumberTree.

put

void put(int key, PDFObject value)

Parameters

key: int

The integer of the PDFObject to put in the tree.

value: PDFObject

The PDFObject to be associated with key.

Returns:

void

Puts a new entry in this NumberTree. If an entry with this name is already in the tree, it is replaced.

remove

void remove(int key)

Parameters

key: int

The integer of the PDFObject to remove from the tree.

Returns:

void

Removes the specified PDFObject from this NumberTree. It does nothing if no PDFObject of that number exists in this NumberTree.