org.verapdf.features.pb.tools

Class PBCreateNodeHelper

java.lang.Object

org.verapdf.features.pb.tools.PBCreateNodeHelper

public final class PBCreateNodeHelper
extends Object

Helps in creating similar nodes in different features objects

Author:

Maksim Bezrukov

Method Summary

Modifier and Type	Method and Description
static FeatureTreeNode	addBoxFeature(String name, PDRectangle box, FeatureTreeNode parent) Creates feature node for boxes
static FeatureTreeNode	addDeviceColorSpaceNode(String name, PDColor color, FeatureTreeNode parent, FeatureExtractionResult collection) Creates new node for device color space
static FeatureTreeNode	addNotEmptyNode(String name, String value, FeatureTreeNode parent) Creates new node with given name and value if both of this parametrs are not null
static FeatureTreeNode	createDateNode(String nodeName, FeatureTreeNode parent, Calendar date, FeatureExtractionResult collection) Creates node with date value formatted in XML format from the given Calendar
static String	getStringFromBase(COSBase baseParam) Gets String value from COSBase class
static byte[]	inputStreamToByteArray(InputStream is) Generates byte array with contents of a stream
static void	parseFloatMatrix(float[][] array, FeatureTreeNode parent)
static void	parseIDSet(Set<String> set, String elementName, String setName, FeatureTreeNode root) Creates elements with name elementName and attribute id with values from set and attach them to the root element in case, when setName is null and to the element with root parent and name elementName in other case
static FeatureTreeNode	parseMetadata(PDMetadata metadata, String nodeName, FeatureTreeNode parent, FeatureExtractionResult collection) Creates FeatureTreeNode with name nodeName, parent parent, and content which is a stream r epresentation of the metadata content.

Methods inherited from class java.lang.Object

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

Method Detail

createDateNode

public static FeatureTreeNode createDateNode(String nodeName,
                                             FeatureTreeNode parent,
                                             Calendar date,
                                             FeatureExtractionResult collection)
                                      throws FeatureParsingException

Creates node with date value formatted in XML format from the given Calendar

Parameters:

nodeName - name of the created node

parent - parent element for created node

date - the given date as Calendar class

collection - collection for which this node creates

Returns:

created node

Throws:

FeatureParsingException

getStringFromBase

public static String getStringFromBase(COSBase baseParam)

Gets String value from COSBase class

Parameters:

baseParam - COSBase object

Returns:

String value of a COSString object if the direct object that will get from the given COSBase is COSString and null in all other cases

addBoxFeature

public static FeatureTreeNode addBoxFeature(String name,
                                            PDRectangle box,
                                            FeatureTreeNode parent)
                                     throws FeatureParsingException

Creates feature node for boxes

Parameters:

name - name of the node

box - PDRectangle object represents the box

parent - parent element for the created node

Returns:

created node

Throws:

FeatureParsingException

addNotEmptyNode

public static FeatureTreeNode addNotEmptyNode(String name,
                                              String value,
                                              FeatureTreeNode parent)
                                       throws FeatureParsingException

Creates new node with given name and value if both of this parametrs are not null

Parameters:

name - name of the node

value - value of the node

parent - parent of the node

Returns:

generated node

Throws:

FeatureParsingException

addDeviceColorSpaceNode

public static FeatureTreeNode addDeviceColorSpaceNode(String name,
                                                      PDColor color,
                                                      FeatureTreeNode parent,
                                                      FeatureExtractionResult collection)
                                               throws FeatureParsingException

Creates new node for device color space

Parameters:

name - name for the created node

color - PDColor class represents device color space for creating node

parent - parent node for the creating node

collection - features collection in which parent situated

Returns:

created node

Throws:

FeatureParsingException

parseIDSet

public static void parseIDSet(Set<String> set,
                              String elementName,
                              String setName,
                              FeatureTreeNode root)
                       throws FeatureParsingException

Creates elements with name elementName and attribute id with values from set and attach them to the root element in case, when setName is null and to the element with root parent and name elementName in other case

Parameters:

set - set of elements id

elementName - element names

setName - name of the parent element for created elements. If null, all created elements will be attached to the root

root - root element for the generated parent element for generated elements or direct paren for generated elements in case of setName equals to null

Throws:

FeatureParsingException

inputStreamToByteArray

public static byte[] inputStreamToByteArray(InputStream is)
                                     throws IOException

Generates byte array with contents of a stream

Parameters:

is - input stream for converting

Returns:

byte array with contents of a stream

Throws:

IOException - If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.

parseMetadata

public static FeatureTreeNode parseMetadata(PDMetadata metadata,
                                            String nodeName,
                                            FeatureTreeNode parent,
                                            FeatureExtractionResult collection)
                                     throws FeatureParsingException

Creates FeatureTreeNode with name nodeName, parent parent, and content which is a stream r epresentation of the metadata content. If there is an exception during getting metadata, then it will create node with errorID and error for this situation.

Parameters:

metadata - PDMetadata class from which metadata will be taken

nodeName - name for the created node

collection - collection for the created node

Returns:

created node

Throws:

FeatureParsingException - occurs when wrong features tree node constructs

parseFloatMatrix

public static void parseFloatMatrix(float[][] array,
                                    FeatureTreeNode parent)
                             throws FeatureParsingException

Throws:

FeatureParsingException