Class TableStructElementIterator

java.lang.Object

com.itextpdf.pdfua.checkers.utils.tables.TableStructElementIterator

All Implemented Interfaces:

ITableIterator<PdfStructElem>

public class TableStructElementIterator
extends Object
implements ITableIterator<PdfStructElem>

Creates an iterator to iterate over the table structures.

Field Summary

Fields

Modifier and Type	Field	Description
private final List<PdfStructElem>	all
private int	amountOfCols
private int	amountOfRowsBody
private int	amountOfRowsFooter
private int	amountOfRowsHeader
(package private) final PdfUAValidationContext	context
private PdfStructElem	currentValue
private int	iterIndex
private final HashMap<PdfStructElem, Tuple2<Integer,Integer>>	locationCache

Constructor Summary

Constructors

Constructor	Description
TableStructElementIterator(PdfStructElem tableStructElem, PdfUAValidationContext context)	Creates a new TableStructElementIterator instance.

Method Summary

Modifier and Type	Method	Description
private void	build2DRepresentationOfTagTreeStructures(List<PdfStructElem> rows)
private List<PdfStructElem>	extractAllTrTags(List<IStructureNode> possibleTrs)
private List<PdfStructElem>	extractCells(PdfStructElem row)
private List<PdfStructElem>	extractTableRows(PdfStructElem table)
private void	flattenElements(PdfStructElem table)
int	getAmountOfRowsBody()	Gets the number of rows in the body of the table.
int	getAmountOfRowsFooter()	Gets the number of rows in the footer of the table.
int	getAmountOfRowsHeader()	Gets the number of rows in the header of the table.
int	getCol()	Gets the column index of current position.
int	getColspan()	Gets the colspan of the current position
private static int	getColspan(PdfStructElem structElem)
private static int	getIntValueFromAttributes(PdfStructElem elem, PdfName name)
int	getNumberOfColumns()	Returns the amount of columns the table has.
private PdfName	getRole(IStructureNode node)
int	getRow()	Gets the row index of the current position.
int	getRowspan()	Gets the rowspan of current position.
private static int	getRowspan(PdfStructElem structElem)
boolean	hasNext()	Checks if there is a next element in the iteration.
PdfStructElem	next()	Gets the next element in the iteration.
private void	setAmountOfCols(List<PdfStructElem> rows)

Methods inherited from class Object

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

Field Details

context

final PdfUAValidationContext context

all

private final List<PdfStructElem> all

locationCache

private final HashMap<PdfStructElem, Tuple2<Integer,Integer>> locationCache

amountOfCols

private int amountOfCols

amountOfRowsHeader

private int amountOfRowsHeader

amountOfRowsBody

private int amountOfRowsBody

amountOfRowsFooter

private int amountOfRowsFooter

iterIndex

private int iterIndex

currentValue

private PdfStructElem currentValue

Constructor Details

TableStructElementIterator

public TableStructElementIterator(PdfStructElem tableStructElem,
 PdfUAValidationContext context)

Creates a new TableStructElementIterator instance.

Parameters:

tableStructElem - the root table struct element.

context - the validation context.

Method Details

hasNext

public boolean hasNext()

Checks if there is a next element in the iteration.

Specified by:

hasNext in interface ITableIterator<PdfStructElem>

Returns:

true if there is a next element, false otherwise

next

public PdfStructElem next()

Gets the next element in the iteration.

Specified by:

next in interface ITableIterator<PdfStructElem>

Returns:

the next element

getAmountOfRowsBody

public int getAmountOfRowsBody()

Gets the number of rows in the body of the table.

Specified by:

getAmountOfRowsBody in interface ITableIterator<PdfStructElem>

Returns:

the number of rows in the body of the table

getAmountOfRowsHeader

public int getAmountOfRowsHeader()

Gets the number of rows in the header of the table.

Specified by:

getAmountOfRowsHeader in interface ITableIterator<PdfStructElem>

Returns:

the number of rows in the header of the table

getAmountOfRowsFooter

public int getAmountOfRowsFooter()

Gets the number of rows in the footer of the table.

Specified by:

getAmountOfRowsFooter in interface ITableIterator<PdfStructElem>

Returns:

the number of rows in the footer of the table

getNumberOfColumns

public int getNumberOfColumns()

Returns the amount of columns the table has. All rows in a table in UA specification must have the same column count. So return the max column count for correctly generated error messages.

Specified by:

getNumberOfColumns in interface ITableIterator<PdfStructElem>

Returns:

the amount of columns

getRow

public int getRow()

Gets the row index of the current position.

Specified by:

getRow in interface ITableIterator<PdfStructElem>

Returns:

the row index

getCol

public int getCol()

Gets the column index of current position.

Specified by:

getCol in interface ITableIterator<PdfStructElem>

Returns:

the column index

getRowspan

public int getRowspan()

Gets the rowspan of current position.

Specified by:

getRowspan in interface ITableIterator<PdfStructElem>

Returns:

the rowspan

getColspan

public int getColspan()

Gets the colspan of the current position

Specified by:

getColspan in interface ITableIterator<PdfStructElem>

Returns:

the colspan of current position

flattenElements

private void flattenElements(PdfStructElem table)

getRole

private PdfName getRole(IStructureNode node)

extractTableRows

private List<PdfStructElem> extractTableRows(PdfStructElem table)

build2DRepresentationOfTagTreeStructures

private void build2DRepresentationOfTagTreeStructures(List<PdfStructElem> rows)

setAmountOfCols

private void setAmountOfCols(List<PdfStructElem> rows)

extractCells

private List<PdfStructElem> extractCells(PdfStructElem row)

getColspan

private static int getColspan(PdfStructElem structElem)

getRowspan

private static int getRowspan(PdfStructElem structElem)

getIntValueFromAttributes

private static int getIntValueFromAttributes(PdfStructElem elem,
 PdfName name)

extractAllTrTags

private List<PdfStructElem> extractAllTrTags(List<IStructureNode> possibleTrs)