org.verapdf.model.impl.pb.pd

Class PBoxPDStructElem

java.lang.Object

org.verapdf.model.GenericModelObject

org.verapdf.model.impl.pb.pd.PBoxPDObject

org.verapdf.model.impl.pb.pd.PBoxPDStructElem

All Implemented Interfaces:

Object, PDObject, PDStructElem

public class PBoxPDStructElem
extends PBoxPDObject
implements PDStructElem

Current class is representation of node of structure tree root. Implemented by Apache PDFBox.

Author:

Evgeniy Muravitskiy

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHILDREN Link name for K key
static String	LANG Link name for Lang key
static String	STRUCTURE_ELEMENT_TYPE Type name for PBoxPDStructElem
static String	STRUCTURE_TYPE Link name for S key

Fields inherited from class org.verapdf.model.impl.pb.pd.PBoxPDObject

cMap, contentStream, document, MAX_NUMBER_OF_ELEMENTS, pdFontLike, simplePDObject

Fields inherited from class org.verapdf.model.GenericModelObject

contextDependent

Constructor Summary

Constructors

Constructor and Description
PBoxPDStructElem(COSDictionary structElemDictionary, TaggedPDFRoleMapHelper roleMapHelper) Default constructor

Method Summary

Modifier and Type	Method and Description
Boolean	gethasContentItems() true if the structure element contains content items as its children
String	getkidsStandardTypes() ampersand separated list of child element types, role mapped to the standard types
List<? extends Object>	getLinkedObjects(String link)
String	getstandardType() standard structure type defined via role map
String	getType() the value of the Type entry
static boolean	isContentItem(COSBase base)

Methods inherited from class org.verapdf.model.impl.pb.pd.PBoxPDObject

addAction, getID

Methods inherited from class org.verapdf.model.GenericModelObject

getExtraContext, getLinks, getObjectType, getProperties, getSuperTypes, isContextDependent

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.verapdf.model.baselayer.Object

getExtraContext, getID, getLinks, getObjectType, getProperties, getSuperTypes, isContextDependent

Field Detail

STRUCTURE_ELEMENT_TYPE

public static final String STRUCTURE_ELEMENT_TYPE

Type name for PBoxPDStructElem

See Also:

Constant Field Values

CHILDREN

public static final String CHILDREN

Link name for K key

See Also:

Constant Field Values

STRUCTURE_TYPE

public static final String STRUCTURE_TYPE

Link name for S key

See Also:

Constant Field Values

LANG

public static final String LANG

Link name for Lang key

See Also:

Constant Field Values

Constructor Detail

PBoxPDStructElem

public PBoxPDStructElem(COSDictionary structElemDictionary,
                        TaggedPDFRoleMapHelper roleMapHelper)

Default constructor

Parameters:

structElemDictionary - dictionary of structure element

Method Detail

getType

public String getType()

Description copied from interface: PDStructElem

the value of the Type entry

Specified by:

getType in interface PDStructElem

Returns:

Type entry of current structure element

getkidsStandardTypes

public String getkidsStandardTypes()

Description copied from interface: PDStructElem

ampersand separated list of child element types, role mapped to the standard types

Specified by:

getkidsStandardTypes in interface PDStructElem

gethasContentItems

public Boolean gethasContentItems()

Description copied from interface: PDStructElem

true if the structure element contains content items as its children

Specified by:

gethasContentItems in interface PDStructElem

isContentItem

public static boolean isContentItem(COSBase base)

getstandardType

public String getstandardType()

Description copied from interface: PDStructElem

standard structure type defined via role map

Specified by:

getstandardType in interface PDStructElem

getLinkedObjects

public List<? extends Object> getLinkedObjects(String link)

Specified by:

getLinkedObjects in interface Object

Overrides:

getLinkedObjects in class GenericModelObject

Parameters:

link - - the name of a link

Returns:

List of objects with the given link