Package org.apache.pdfbox.pdmodel.common
Class PDNameTreeNode<T extends COSObjectable>
- java.lang.Object
-
- org.apache.pdfbox.pdmodel.common.PDNameTreeNode<T>
-
- Type Parameters:
T
- The type of the values in this name tree.
- All Implemented Interfaces:
COSObjectable
- Direct Known Subclasses:
PDDestinationNameTreeNode
,PDEmbeddedFilesNameTreeNode
,PDJavascriptNameTreeNode
,PDStructureElementNameTreeNode
public abstract class PDNameTreeNode<T extends COSObjectable> extends java.lang.Object implements COSObjectable
This class represents a node in a name tree.
-
-
Field Summary
Fields Modifier and Type Field Description private static org.apache.commons.logging.Log
LOG
private COSDictionary
node
private PDNameTreeNode<T>
parent
-
Constructor Summary
Constructors Modifier Constructor Description protected
PDNameTreeNode()
Constructor.protected
PDNameTreeNode(COSDictionary dict)
Constructor.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description private void
calculateLimits()
protected abstract T
convertCOSToPD(COSBase base)
Method to convert the COS value in the name tree to the PD Model object.protected abstract PDNameTreeNode<T>
createChildNode(COSDictionary dic)
Create a child node object.COSDictionary
getCOSObject()
Convert this standard java object to a COS object.java.util.List<PDNameTreeNode<T>>
getKids()
Return the children of this node.java.lang.String
getLowerLimit()
Get the lowest value for a key in the name map.java.util.Map<java.lang.String,T>
getNames()
This will return a map of names on this level.PDNameTreeNode<T>
getParent()
Returns the parent node.java.lang.String
getUpperLimit()
Get the highest value for a key in the name map.T
getValue(java.lang.String name)
The name to retrieve.boolean
isRootNode()
Determines if this is a root node or not.void
setKids(java.util.List<? extends PDNameTreeNode<T>> kids)
Set the children of this named tree.private void
setLowerLimit(java.lang.String lower)
Set the lowest value for the key in the map.void
setNames(java.util.Map<java.lang.String,T> names)
Set the names for this node.void
setParent(PDNameTreeNode<T> parentNode)
Sets the parent to the given node.private void
setUpperLimit(java.lang.String upper)
Set the highest value for the key in the map.
-
-
-
Field Detail
-
LOG
private static final org.apache.commons.logging.Log LOG
-
node
private final COSDictionary node
-
parent
private PDNameTreeNode<T extends COSObjectable> parent
-
-
Constructor Detail
-
PDNameTreeNode
protected PDNameTreeNode()
Constructor.
-
PDNameTreeNode
protected PDNameTreeNode(COSDictionary dict)
Constructor.- Parameters:
dict
- The dictionary that holds the name information.
-
-
Method Detail
-
getCOSObject
public COSDictionary getCOSObject()
Convert this standard java object to a COS object.- Specified by:
getCOSObject
in interfaceCOSObjectable
- Returns:
- The cos object that matches this Java object.
-
getParent
public PDNameTreeNode<T> getParent()
Returns the parent node.- Returns:
- parent node
-
setParent
public void setParent(PDNameTreeNode<T> parentNode)
Sets the parent to the given node.- Parameters:
parentNode
- the node to be set as parent
-
isRootNode
public boolean isRootNode()
Determines if this is a root node or not.- Returns:
- true if this is a root node
-
getKids
public java.util.List<PDNameTreeNode<T>> getKids()
Return the children of this node. This list will contain PDNameTreeNode objects.- Returns:
- The list of children or null if there are no children.
-
setKids
public void setKids(java.util.List<? extends PDNameTreeNode<T>> kids)
Set the children of this named tree.- Parameters:
kids
- The children of this named tree.
-
calculateLimits
private void calculateLimits()
-
getValue
public T getValue(java.lang.String name) throws java.io.IOException
The name to retrieve.- Parameters:
name
- The name in the tree.- Returns:
- The value of the name in the tree.
- Throws:
java.io.IOException
- If an there is a problem creating the destinations.
-
getNames
public java.util.Map<java.lang.String,T> getNames() throws java.io.IOException
This will return a map of names on this level. The key will be a string, and the value will depend on where this class is being used.- Returns:
- ordered map of COS objects or
null
if the dictionary contains no 'Names' entry on this level. - Throws:
java.io.IOException
- If there is an error while creating the sub types.- See Also:
getKids()
-
convertCOSToPD
protected abstract T convertCOSToPD(COSBase base) throws java.io.IOException
Method to convert the COS value in the name tree to the PD Model object. The default implementation will simply return the given COSBase object. Subclasses should do something specific.- Parameters:
base
- The COS object to convert.- Returns:
- The converted PD Model object.
- Throws:
java.io.IOException
- If there is an error during creation.
-
createChildNode
protected abstract PDNameTreeNode<T> createChildNode(COSDictionary dic)
Create a child node object.- Parameters:
dic
- The dictionary for the child node object to refer to.- Returns:
- The new child node object.
-
setNames
public void setNames(java.util.Map<java.lang.String,T> names)
Set the names for this node. This method will set the appropriate upper and lower limits based on the keys in the map.- Parameters:
names
- map of names to objects, ornull
for nothing.
-
getUpperLimit
public java.lang.String getUpperLimit()
Get the highest value for a key in the name map.- Returns:
- The highest value for a key in the map.
-
setUpperLimit
private void setUpperLimit(java.lang.String upper)
Set the highest value for the key in the map.- Parameters:
upper
- The new highest value for a key in the map.
-
getLowerLimit
public java.lang.String getLowerLimit()
Get the lowest value for a key in the name map.- Returns:
- The lowest value for a key in the map.
-
setLowerLimit
private void setLowerLimit(java.lang.String lower)
Set the lowest value for the key in the map.- Parameters:
lower
- The new lowest value for a key in the map.
-
-