Package org.verapdf.gf.model.impl.sa

Class GFSAStructElem

java.lang.Object

org.verapdf.model.GenericModelObject

org.verapdf.gf.model.impl.sa.GFSAObject

org.verapdf.gf.model.impl.sa.GFSAStructElem

All Implemented Interfaces:

Object, SAObject, SAStructElem

Direct Known Subclasses:

GFSAAnnot, GFSAArt, GFSAArtifact, GFSAAside, GFSABibEntry, GFSABlockQuote, GFSACaption, GFSACode, GFSADiv, GFSADocument, GFSADocumentFragment, GFSAEm, GFSAFENote, GFSAFigure, GFSAForm, GFSAFormula, GFSAH, GFSAHn, GFSAIndex, GFSAL, GFSALbl, GFSALBody, GFSALI, GFSALink, GFSANonStandard, GFSANonStruct, GFSANote, GFSAP, GFSAPart, GFSAPrivate, GFSAQuote, GFSARB, GFSAReference, GFSARP, GFSART, GFSARuby, GFSASect, GFSASpan, GFSAStrong, GFSASub, GFSATable, GFSATableCell, GFSATBody, GFSATFoot, GFSATHead, GFSATitle, GFSATOC, GFSATOCI, GFSATR, GFSAWarichu, GFSAWP, GFSAWT

public class GFSAStructElem
extends GFSAObject
implements SAStructElem

Author:

Maxim Plushchov

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Object>	children
static final String	CHILDREN
protected final PDStructElem	structElemDictionary

Fields inherited from class org.verapdf.gf.model.impl.sa.GFSAObject

object

Fields inherited from class org.verapdf.model.GenericModelObject

contextDependent

Constructor Summary

Constructors

Constructor	Description
GFSAStructElem(PDStructElem structElemDictionary, String standardType, String type, String parentsStandardTypes)

Method Summary

Modifier and Type	Method	Description
int	addTextChunk(int number, List<IChunk> chunks)
List<Object>	getChildren()
Double	getcorrectSemanticScore()	number ranging from 0 to 1 indicating the probability that the correct type is right defined
String	getcorrectType()	supposed correct element type
Boolean	gethasLowestDepthError()	true, if this element has wrong type and all parents of this element have right types
String	getID()
Boolean	getisLeafElem()	false, if structure element contains other structure elements
Boolean	getisListChild()	true, if this is list child element
Boolean	getisListElem()	true, if this is list struct element
Boolean	getisTableChild()	true, if this is table child element
Boolean	getisTableElem()	true, if this is table struct element
String	getkidsStandardTypes()	ampersand separated list of child element types, role mapped to the standard types
Long	getlastPage()	number of the last page that contains the structure element
List<? extends Object>	getLinkedObjects(String link)
INode	getNode()
Long	getpage()	number of the first page that contains the structure element
COSKey	getPageObjectNumber()
String	getparentsStandardTypes()	ampersand separated list of all standard types of parents element of this structure element in the structure hierarchy
String	getparentStandardType()	parent element type, role mapped to the standard type
String	getstandardType()	standard type of struct element
PDStructElem	getStructElemDictionary()
String	getStructureType()
String	getTextValue()
String	getType()
String	getvalueS()	structure type
protected void	parseChildren()
void	setNode(INode node)

Methods inherited from class org.verapdf.gf.model.impl.sa.GFSAObject

getContext, geterrorArguments, getErrorArguments, geterrorCodes, getErrorCodes, getObject, getstructureID, setObject

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

getContext, getExtraContext, getLinks, getObjectType, getProperties, getSuperTypes, isContextDependent

Methods inherited from interface org.verapdf.model.salayer.SAObject

geterrorArguments, geterrorCodes, getstructureID

Field Details

CHILDREN

public static final String CHILDREN

See Also:

• Constant Field Values

structElemDictionary

protected final PDStructElem structElemDictionary

children

protected List<Object> children

Constructor Details

GFSAStructElem

public GFSAStructElem(PDStructElem structElemDictionary,
 String standardType,
 String type,
 String parentsStandardTypes)

Method Details

setNode

public void setNode(INode node)

getNode

public INode getNode()

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

getType

public String getType()

getStructureType

public String getStructureType()

getstandardType

public String getstandardType()

Description copied from interface: SAStructElem

standard type of struct element

Specified by:

getstandardType in interface SAStructElem

getisTableElem

public Boolean getisTableElem()

Description copied from interface: SAStructElem

true, if this is table struct element

Specified by:

getisTableElem in interface SAStructElem

getisListElem

public Boolean getisListElem()

Description copied from interface: SAStructElem

true, if this is list struct element

Specified by:

getisListElem in interface SAStructElem

getisTableChild

public Boolean getisTableChild()

Description copied from interface: SAStructElem

true, if this is table child element

Specified by:

getisTableChild in interface SAStructElem

getisListChild

public Boolean getisListChild()

Description copied from interface: SAStructElem

true, if this is list child element

Specified by:

getisListChild in interface SAStructElem

getisLeafElem

public Boolean getisLeafElem()

Description copied from interface: SAStructElem

false, if structure element contains other structure elements

Specified by:

getisLeafElem in interface SAStructElem

getChildren

public List<Object> getChildren()

parseChildren

protected void parseChildren()

addTextChunk

public int addTextChunk(int number,
 List<IChunk> chunks)

getcorrectSemanticScore

public Double getcorrectSemanticScore()

Description copied from interface: SAStructElem

number ranging from 0 to 1 indicating the probability that the correct type is right defined

Specified by:

getcorrectSemanticScore in interface SAStructElem

getvalueS

public String getvalueS()

Description copied from interface: SAStructElem

structure type

Specified by:

getvalueS in interface SAStructElem

getcorrectType

public String getcorrectType()

Description copied from interface: SAStructElem

supposed correct element type

Specified by:

getcorrectType in interface SAStructElem

getID

public String getID()

Specified by:

getID in interface Object

Overrides:

getID in class GenericModelObject

Returns:

id of the current object

getPageObjectNumber

public COSKey getPageObjectNumber()

getparentsStandardTypes

public String getparentsStandardTypes()

Description copied from interface: SAStructElem

ampersand separated list of all standard types of parents element of this structure element in the structure hierarchy

Specified by:

getparentsStandardTypes in interface SAStructElem

getkidsStandardTypes

public String getkidsStandardTypes()

Description copied from interface: SAStructElem

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

Specified by:

getkidsStandardTypes in interface SAStructElem

getparentStandardType

public String getparentStandardType()

Description copied from interface: SAStructElem

parent element type, role mapped to the standard type

Specified by:

getparentStandardType in interface SAStructElem

getTextValue

public String getTextValue()

gethasLowestDepthError

public Boolean gethasLowestDepthError()

Description copied from interface: SAStructElem

true, if this element has wrong type and all parents of this element have right types

Specified by:

gethasLowestDepthError in interface SAStructElem

getpage

public Long getpage()

Description copied from interface: SAStructElem

number of the first page that contains the structure element

Specified by:

getpage in interface SAStructElem

getlastPage

public Long getlastPage()

Description copied from interface: SAStructElem

number of the last page that contains the structure element

Specified by:

getlastPage in interface SAStructElem

getStructElemDictionary

public PDStructElem getStructElemDictionary()