org.verapdf.processor.config

Class Config

java.lang.Object

org.verapdf.processor.config.Config

public final class Config
extends Object

Author:

Maksim Bezrukov

Field Summary

Fields

Modifier and Type	Field and Description
static Path	DEFAULT_FEATURES_CONFIG_PATH
static Path	DEFAULT_FIX_METADATA_PATH_FOLDER
static PDFAFlavour	DEFAULT_FLAVOUR
static boolean	DEFAULT_IS_FIX_METADATA
static boolean	DEFAULT_IS_OVERWRITE_REPORT_FILE
static int	DEFAULT_MAX_NUMBER_OF_DISPLAYED_FAILED_CHECKS
static int	DEFAULT_MAX_NUMBER_OF_FAILED_CHECKS
static String	DEFAULT_METADATA_FIXER_PREFIX
static Path	DEFAULT_PLUGINS_CONFIG_PATH
static Path	DEFAULT_POLICY_PROFILE
static ProcessingType	DEFAULT_PROCESSING_TYPE
static String	DEFAULT_PROFILES_WIKI_PATH
static String	DEFAULT_REPORT_FILE_PATH
static String	DEFAULT_REPORT_FOLDER_PATH
static FormatOption	DEFAULT_REPORT_TYPE
static boolean	DEFAULT_SHOW_PASSED_RULES
static Path	DEFAULT_VALIDATION_PROFILE_PATH
static boolean	DEFAULT_VERBOSE_CLI

Constructor Summary

Constructors

Constructor and Description
Config()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
static Config	fromXml(InputStream toConvert) Converts XML file to Config,
static Config	fromXml(String toConvert) Converts XML file to Config,
Path	getFeaturesConfigFilePath()
Path	getFixMetadataFolder()
PDFAFlavour	getFlavour()
int	getMaxNumberOfDisplayedFailedChecks()
int	getMaxNumberOfFailedChecks()
String	getMetadataFixerPrefix()
Path	getPluginsConfigFilePath()
Path	getPolicyProfile()
ProcessingType	getProcessingType()
String	getProfileWikiPath()
String	getReportFile()
String	getReportFolder()
FormatOption	getReportType()
Path	getValidationProfile()
int	hashCode()
boolean	isFixMetadata()
boolean	isOverwriteReportFile()
boolean	isShowPassedRules()
static boolean	isValidFileNameCharacter(char c) Checks is the character valid for file name
static boolean	isValidFolderPath(Path path) Checks is the parameter path a valid for saving fixed file
static boolean	isValidProfilePath(Path path) Checks is the parameter path a valid validation profile
boolean	isVerboseCli()
void	setFeaturesConfigPath(Path featuresConfigPath) Changes settings parameters
void	setFixMetadata(boolean fixMetadata) Changes settings parameters
void	setFixMetadataPathFolder(Path fixMetadataPathFolder) Changes settings parameters
void	setFlavour(PDFAFlavour flavour) Changes settings parameters
void	setMaxNumberOfDisplayedFailedChecks(int maxNumberOfDisplayedFailedChecks) Changes settings parameter
void	setMaxNumberOfFailedChecks(int maxNumberOfFailedChecks) Changes settings parameter
void	setMetadataFixerPrefix(String metadataFixerPrefix) Changes settings parameters
void	setOverwriteReportFile(boolean overwriteReportFile) Changes settings parameters
void	setPluginsConfigPath(Path pluginsConfigPath) Changes settings parameters
void	setPolicyProfilePath(Path policyProfilePath) Changes settings parameters
void	setProcessingType(ProcessingType processingType) Changes settings parameters
void	setProfileWikiPath(String profileWikiPath) Changes settings parameters
void	setReportFilePath(String reportFile) Changes settings parameters
void	setReportFolderPath(String reportFolder) Changes settings parameters
void	setReportType(FormatOption reportType) Changes settings parameters
void	setShowPassedRules(boolean showPassedRules) Changes settings parameter
void	setValidationProfilePath(Path validationProfilePath) Changes settings parameters
void	setVerboseCli(boolean verboseCli) Changes settings parameters
static String	toXml(Config toConvert, Boolean prettyXml) Converts Config to XML,
static void	toXml(Config toConvert, OutputStream stream, Boolean prettyXml) Converts Config to XML,

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_NUMBER_OF_FAILED_CHECKS

public static final int DEFAULT_MAX_NUMBER_OF_FAILED_CHECKS

See Also:

Constant Field Values

DEFAULT_SHOW_PASSED_RULES

public static final boolean DEFAULT_SHOW_PASSED_RULES

See Also:

Constant Field Values

DEFAULT_MAX_NUMBER_OF_DISPLAYED_FAILED_CHECKS

public static final int DEFAULT_MAX_NUMBER_OF_DISPLAYED_FAILED_CHECKS

See Also:

Constant Field Values

DEFAULT_METADATA_FIXER_PREFIX

public static final String DEFAULT_METADATA_FIXER_PREFIX

See Also:

Constant Field Values

DEFAULT_FIX_METADATA_PATH_FOLDER

public static final Path DEFAULT_FIX_METADATA_PATH_FOLDER

DEFAULT_PROFILES_WIKI_PATH

public static final String DEFAULT_PROFILES_WIKI_PATH

See Also:

Constant Field Values

DEFAULT_IS_FIX_METADATA

public static final boolean DEFAULT_IS_FIX_METADATA

See Also:

Constant Field Values

DEFAULT_PROCESSING_TYPE

public static final ProcessingType DEFAULT_PROCESSING_TYPE

DEFAULT_REPORT_TYPE

public static final FormatOption DEFAULT_REPORT_TYPE

DEFAULT_VALIDATION_PROFILE_PATH

public static final Path DEFAULT_VALIDATION_PROFILE_PATH

DEFAULT_FLAVOUR

public static final PDFAFlavour DEFAULT_FLAVOUR

DEFAULT_VERBOSE_CLI

public static final boolean DEFAULT_VERBOSE_CLI

See Also:

Constant Field Values

DEFAULT_POLICY_PROFILE

public static final Path DEFAULT_POLICY_PROFILE

DEFAULT_PLUGINS_CONFIG_PATH

public static final Path DEFAULT_PLUGINS_CONFIG_PATH

DEFAULT_FEATURES_CONFIG_PATH

public static final Path DEFAULT_FEATURES_CONFIG_PATH

DEFAULT_REPORT_FOLDER_PATH

public static final String DEFAULT_REPORT_FOLDER_PATH

See Also:

Constant Field Values

DEFAULT_REPORT_FILE_PATH

public static final String DEFAULT_REPORT_FILE_PATH

See Also:

Constant Field Values

DEFAULT_IS_OVERWRITE_REPORT_FILE

public static final boolean DEFAULT_IS_OVERWRITE_REPORT_FILE

See Also:

Constant Field Values

Constructor Detail

Config

public Config()

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getMaxNumberOfDisplayedFailedChecks

public int getMaxNumberOfDisplayedFailedChecks()

Returns:

selected number for maximum displayed fail checks for a rule. If not selected returns -1

getMaxNumberOfFailedChecks

public int getMaxNumberOfFailedChecks()

Returns:

selected number for maximum fail checks for a rule. If not selected returns -1

isShowPassedRules

public boolean isShowPassedRules()

Returns:

true if desplay passed pules option selected

getMetadataFixerPrefix

public String getMetadataFixerPrefix()

Returns:

String representation of prefix for fixed files

getFixMetadataFolder

public Path getFixMetadataFolder()

Returns:

path to the folder in which fixed file will be placed

getProcessingType

public ProcessingType getProcessingType()

Returns:

type of operation to be performed, e. g. validation & feature describing

isFixMetadata

public boolean isFixMetadata()

Returns:

true if metadata fixes are to be performed

getProfileWikiPath

public String getProfileWikiPath()

Returns:

path to the profiles wiki

getReportType

public FormatOption getReportType()

Returns:

type of report to be generated

getPolicyProfile

public Path getPolicyProfile()

Returns:

path to the policy profile

getValidationProfile

public Path getValidationProfile()

Returns:

path to validation profile to be used. If returned value is null, then validation flavour is processed

getFlavour

public PDFAFlavour getFlavour()

Returns:

validation flavour to be used

isVerboseCli

public boolean isVerboseCli()

Returns:

true if cli text report will be verbose

getPluginsConfigFilePath

public Path getPluginsConfigFilePath()

Returns:

path to the plugins config file

getFeaturesConfigFilePath

public Path getFeaturesConfigFilePath()

Returns:

path to the features config file

getReportFolder

public String getReportFolder()

Returns:

path to folder for reports

getReportFile

public String getReportFile()

Returns:

path for report file

isOverwriteReportFile

public boolean isOverwriteReportFile()

toXml

public static String toXml(Config toConvert,
           Boolean prettyXml)
                    throws JAXBException,
                           IOException

Converts Config to XML,

Throws:

JAXBException

IOException

See Also:

for more details

fromXml

public static Config fromXml(String toConvert)
                      throws JAXBException

Converts XML file to Config,

Throws:

JAXBException

See Also:

for more details

toXml

public static void toXml(Config toConvert,
         OutputStream stream,
         Boolean prettyXml)
                  throws JAXBException

Converts Config to XML,

Throws:

JAXBException

See Also:

for more details

fromXml

public static Config fromXml(InputStream toConvert)
                      throws JAXBException

Converts XML file to Config,

Throws:

JAXBException

See Also:

for more details

setMetadataFixerPrefix

public void setMetadataFixerPrefix(String metadataFixerPrefix)

Changes settings parameters

Parameters:

metadataFixerPrefix - a prefix which will be added to the fixed file

Throws:

IllegalArgumentException - parameter can not be null

setShowPassedRules

public void setShowPassedRules(boolean showPassedRules)

Changes settings parameter

Parameters:

showPassedRules - true for show passed rules at the report

setMaxNumberOfFailedChecks

public void setMaxNumberOfFailedChecks(int maxNumberOfFailedChecks)

Changes settings parameter

Parameters:

maxNumberOfFailedChecks - a natural number that indicates maximum number of failed checks for rule or -1 for unlimited

Throws:

IllegalArgumentException - if parameter is not a natural number or -1

setMaxNumberOfDisplayedFailedChecks

public void setMaxNumberOfDisplayedFailedChecks(int maxNumberOfDisplayedFailedChecks)

Changes settings parameter

Parameters:

maxNumberOfDisplayedFailedChecks - a non negative integer number that indicates maximum number of displayed failed checks for rule or -1 for infinite

Throws:

IllegalArgumentException - if parameter is less than -1

setFixMetadataPathFolder

public void setFixMetadataPathFolder(Path fixMetadataPathFolder)

Changes settings parameters

Parameters:

fixMetadataPathFolder - a path to the folder in which fixed files will be saved

Throws:

IllegalArgumentException - parameter should be an empty path or a path to an existing and write acceptable directory

setProfileWikiPath

public void setProfileWikiPath(String profileWikiPath)

Changes settings parameters

Parameters:

profileWikiPath - a link to wiki about validation rules

setFixMetadata

public void setFixMetadata(boolean fixMetadata)

Changes settings parameters

Parameters:

fixMetadata - true if metadata fixes should be performed

setProcessingType

public void setProcessingType(ProcessingType processingType)

Changes settings parameters

Parameters:

processingType - type of operation to be performed

setReportType

public void setReportType(FormatOption reportType)

Changes settings parameters

Parameters:

reportType - type of report to be generated

setValidationProfilePath

public void setValidationProfilePath(Path validationProfilePath)

Changes settings parameters

Parameters:

validationProfilePath - a path to the validation profile to be used in validation

Throws:

IllegalArgumentException - parameter should be an empty path or a path to an existing and write acceptable file

setPolicyProfilePath

public void setPolicyProfilePath(Path policyProfilePath)

Changes settings parameters

Parameters:

policyProfilePath - a path to the policy profile to be used in policy checks

Throws:

IllegalArgumentException - parameter should be an empty path or a path to an existing and write acceptable file

setPluginsConfigPath

public void setPluginsConfigPath(Path pluginsConfigPath)

Changes settings parameters

Parameters:

pluginsConfigPath - a path to the plugins config file

setFeaturesConfigPath

public void setFeaturesConfigPath(Path featuresConfigPath)

Changes settings parameters

Parameters:

featuresConfigPath - a path to the features config file

setFlavour

public void setFlavour(PDFAFlavour flavour)

Changes settings parameters

Parameters:

flavour - validation flavour to be used

setVerboseCli

public void setVerboseCli(boolean verboseCli)

Changes settings parameters

Parameters:

verboseCli - true if cli text report should be verbose

setReportFolderPath

public void setReportFolderPath(String reportFolder)

Changes settings parameters

Parameters:

reportFolder - path to folder where results will be saved

setReportFilePath

public void setReportFilePath(String reportFile)

Changes settings parameters

Parameters:

reportFile - path to report file

setOverwriteReportFile

public void setOverwriteReportFile(boolean overwriteReportFile)

Changes settings parameters

Parameters:

overwriteReportFile - report file overwriting flag

isValidFolderPath

public static boolean isValidFolderPath(Path path)

Checks is the parameter path a valid for saving fixed file

Parameters:

path - path for check

Returns:

true if it is valid

isValidProfilePath

public static boolean isValidProfilePath(Path path)

Checks is the parameter path a valid validation profile

Parameters:

path - path for check

Returns:

true if it is valid

isValidFileNameCharacter

public static boolean isValidFileNameCharacter(char c)

Checks is the character valid for file name

Parameters:

c - character to be checked

Returns:

true if it is valid