de.intarsys.pdf.st
Class STXRefSection

java.lang.Object
  de.intarsys.pdf.st.STXRefSection

Direct Known Subclasses:

STStreamXRefSection, STTrailerXRefSection

public abstract class STXRefSection
extends Object

A section in a XRef.

The XRef allows random access to the objects in the PDF file.

A XRef section is the part of a pdf document starting with a "xref" token. It consists of several, non contiguous subsections, one additional for each incremental update.

Field Summary

static COSName

DK_XRefStm

Method Summary

void	addEntry(STXRefEntry entry)
boolean	contains(int number)
abstract COSDictionary	cosGetDict() The "trailer" dictionary associated with the XRef section.
COSObject	cosGetEncryption()
abstract COSObject	cosGetObject()
void	cosSetEncryption(COSObject encryption)
abstract STXRefSection	createSuccessor()
Iterator	entryIterator()
STDocument	getDoc()
STXRefEntry	getEntry(int number)
COSArray	getID()
int	getIncrementalCount()
int	getMaxObjectNumber()
long	getOffset()
STXRefSection	getPrevious()
int	getPreviousOffset()
int	getSize() The total number of indirect objects in the document.
int	getStart() The object number of the first object in this section.
abstract AbstractXRefWriter	getWriter(COSWriter cosWriter)
STXRefSubsection	getXRefSubsection() The first subsection in this section.
COSObject	load(int objectNumber, ISystemSecurityHandler securityHandler)
Iterator	subsectionIterator()

Methods inherited from class java.lang.Object

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

Field Detail

DK_XRefStm

public static final COSName DK_XRefStm

Method Detail

addEntry

public void addEntry(STXRefEntry entry)

contains

public boolean contains(int number)

cosGetDict

public abstract COSDictionary cosGetDict()

The "trailer" dictionary associated with the XRef section.

Returns:

The "trailer" dictionary associated with the XRef section.

cosGetEncryption

public COSObject cosGetEncryption()

cosGetObject

public abstract COSObject cosGetObject()

cosSetEncryption

public void cosSetEncryption(COSObject encryption)

createSuccessor

public abstract STXRefSection createSuccessor()

entryIterator

public Iterator entryIterator()

getDoc

public STDocument getDoc()

getEntry

public STXRefEntry getEntry(int number)

getID

public COSArray getID()

getIncrementalCount

public int getIncrementalCount()

getMaxObjectNumber

public int getMaxObjectNumber()

getOffset

public long getOffset()

getPrevious

public STXRefSection getPrevious()

getPreviousOffset

public int getPreviousOffset()

Returns:

offset of previous trailer dict or -1 if none exists

getSize

public int getSize()

The total number of indirect objects in the document.

Returns:

The total number of indirect objects in the document.

getStart

public int getStart()

The object number of the first object in this section.

Returns:

The object number of the first object in this section.

getWriter

public abstract AbstractXRefWriter getWriter(COSWriter cosWriter)

getXRefSubsection

public STXRefSubsection getXRefSubsection()

The first subsection in this section. All other subsections are implemented as a linked list.

Returns:

The first subsection in this section.

load

public COSObject load(int objectNumber,
                      ISystemSecurityHandler securityHandler)
               throws IOException,
                      COSLoadException

Throws:

IOException

COSLoadException

subsectionIterator

public Iterator subsectionIterator()