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

Direct Known Subclasses:

PBoxSEGeneral

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, String type) Default constructor

Method Summary

Modifier and Type	Method and Description
String	getActualText() value of the /ActualText entry
String	getAlt() value of the /Alt entry
List<PDStructElem>	getChildren()
Boolean	getcircularMappingExist() true, if circular mapping exist
String	getE() value of the /E entry
Boolean	gethasContentItems() true if the structure element contains content items as its children
Boolean	getisRemappedStandardType() true if type is standard but remapped
String	getkidsStandardTypes() ampersand separated list of child element types, role mapped to the standard types
List<? extends Object>	getLinkedObjects(String link)
String	getparentLang() value of parent Lang entry
String	getparentStandardType() parent element type, role mapped to the standard type
String	getstandardType() standard structure type defined via role map
static String	getStructureElementStandardType(COSDictionary pdStructElem, TaggedPDFRoleMapHelper roleMapHelper)
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

getContext, 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

getContext, 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,
                        String type)

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

getparentStandardType

public String getparentStandardType()

Description copied from interface: PDStructElem

parent element type, role mapped to the standard type

Specified by:

getparentStandardType 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

getparentLang

public String getparentLang()

Description copied from interface: PDStructElem

value of parent Lang entry

Specified by:

getparentLang in interface PDStructElem

getStructureElementStandardType

public static String getStructureElementStandardType(COSDictionary pdStructElem,
                                                     TaggedPDFRoleMapHelper roleMapHelper)

getisRemappedStandardType

public Boolean getisRemappedStandardType()

Description copied from interface: PDStructElem

true if type is standard but remapped

Specified by:

getisRemappedStandardType in interface PDStructElem

getAlt

public String getAlt()

Description copied from interface: PDStructElem

value of the /Alt entry

Specified by:

getAlt in interface PDStructElem

getActualText

public String getActualText()

Description copied from interface: PDStructElem

value of the /ActualText entry

Specified by:

getActualText in interface PDStructElem

getE

public String getE()

Description copied from interface: PDStructElem

value of the /E entry

Specified by:

getE in interface PDStructElem

getcircularMappingExist

public Boolean getcircularMappingExist()

Description copied from interface: PDStructElem

true, if circular mapping exist

Specified by:

getcircularMappingExist 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

getChildren

public List<PDStructElem> getChildren()