org.verapdf.model

Class ModelParser

java.lang.Object

org.verapdf.model.ModelParser

All Implemented Interfaces:

Closeable, AutoCloseable, Component, PDFAParser

public final class ModelParser
extends Object
implements PDFAParser

Current class is entry point to model implementation.

Author:

Evgeniy Muravitskiy

Method Summary

Modifier and Type	Method and Description
void	close()
static ModelParser	createModelWithFlavour(File pdfFile, PDFAFlavour flavour)
static ModelParser	createModelWithFlavour(InputStream toLoad, PDFAFlavour flavour)
ComponentDetails	getDetails()
FeatureExtractionResult	getFeatures(FeatureExtractorConfig config)
FeatureExtractionResult	getFeatures(FeatureExtractorConfig config, List<AbstractFeaturesExtractor> extractors)
PDFAFlavour	getFlavour()
PDFDocument	getPDFDocument()
Object	getRoot() Method return root object of model implementation from pdf box model together with the hierarchy.

Methods inherited from class java.lang.Object

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

Method Detail

createModelWithFlavour

public static ModelParser createModelWithFlavour(InputStream toLoad,
                                                 PDFAFlavour flavour)
                                          throws ModelParsingException,
                                                 EncryptedPdfException

Throws:

ModelParsingException

EncryptedPdfException

createModelWithFlavour

public static ModelParser createModelWithFlavour(File pdfFile,
                                                 PDFAFlavour flavour)
                                          throws ModelParsingException,
                                                 EncryptedPdfException

Throws:

ModelParsingException

EncryptedPdfException

getPDFDocument

public PDFDocument getPDFDocument()

Specified by:

getPDFDocument in interface PDFAParser

Returns:

the PDFDocument parsed.

getDetails

public ComponentDetails getDetails()

Specified by:

getDetails in interface Component

getRoot

public Object getRoot()

Method return root object of model implementation from pdf box model together with the hierarchy.

Specified by:

getRoot in interface PDFAParser

Returns:

root object representing by CosDocument

Throws:

IOException - when target file is not pdf or pdf file is not contain root object

getFlavour

public PDFAFlavour getFlavour()

Specified by:

getFlavour in interface PDFAParser

Returns:

PDFAFlavour for the model that has been parsed

getFeatures

public FeatureExtractionResult getFeatures(FeatureExtractorConfig config)

Specified by:

getFeatures in interface PDFAParser

Parameters:

config - a FeatureExtractorConfig that denotes the features to be extracted.

Returns:

features collection of the document as a FeatureExtractionResult

getFeatures

public FeatureExtractionResult getFeatures(FeatureExtractorConfig config,
                                           List<AbstractFeaturesExtractor> extractors)

Specified by:

getFeatures in interface PDFAParser

Parameters:

config - a FeatureExtractorConfig that denotes the features to be extracted.

extractors - extractors for features reporting

Returns:

features collection of the document as a FeatureExtractionResult

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable