Package org.fugerit.java.doc.base.parser

Class AbstractDocParser

java.lang.Object

org.fugerit.java.doc.base.parser.AbstractDocParser

All Implemented Interfaces:

DocParser

Direct Known Subclasses:

DocXmlParser

public abstract class AbstractDocParser
extends Object
implements DocParser

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CHECK_VERSION_ERROR
static final int	CHECK_VERSION_OK
static final int	CHECK_VERSION_WARN

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractDocParser(int sourceType)

Method Summary

Modifier and Type	Method	Description
static int	checkVersion(String xsdVersion)
FeatureConfig	getFeatureConfig()	Get the feature config for this parser (implementations of DocParser should use FeatureConfig.DEFAULT if not set)
int	getSourceType()	Returns the source type handled by this parser
DocBase	parse(InputStream is)	Parse a source
DocBase	parse(Reader reader)	Parse a source
protected abstract DocBase	parseWorker(Reader reader)
void	setFeatureConfig(FeatureConfig featureConfig)	Set the feature config for this parser
int	validate(Reader reader)	Validate a source
DocValidationResult	validateResult(Reader reader)	Validate a source
int	validateVersion(Reader reader)	Validate a source, it tries to find the xsd version and validate against the specific version
DocValidationResult	validateVersionResult(Reader reader)	Validate a source, it tries to find the xsd version and validate against the specific version
protected abstract DocValidationResult	validateWorker(Reader reader, boolean parseVersion)

Methods inherited from class java.lang.Object

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

Field Details

CHECK_VERSION_OK

public static final int CHECK_VERSION_OK

See Also:

• Constant Field Values

CHECK_VERSION_WARN

public static final int CHECK_VERSION_WARN

See Also:

• Constant Field Values

CHECK_VERSION_ERROR

public static final int CHECK_VERSION_ERROR

See Also:

• Constant Field Values

Constructor Details

AbstractDocParser

protected AbstractDocParser(int sourceType)

Method Details

checkVersion

public static int checkVersion(String xsdVersion)

getSourceType

public int getSourceType()

Description copied from interface: DocParser

Returns the source type handled by this parser

Specified by:

getSourceType in interface DocParser

Returns:

the int representation of the source type handled by this parser DocFacadeSource

parse

public DocBase parse(InputStream is)
              throws DocException

Description copied from interface: DocParser

Parse a source

Specified by:

parse in interface DocParser

Parameters:

is - the source stream

Returns:

the parsed document

Throws:

DocException - in case of problems

getFeatureConfig

public FeatureConfig getFeatureConfig()

Description copied from interface: DocParser

Get the feature config for this parser (implementations of DocParser should use FeatureConfig.DEFAULT if not set)

Specified by:

getFeatureConfig in interface DocParser

Returns:

featuerConfig

setFeatureConfig

public void setFeatureConfig(FeatureConfig featureConfig)

Description copied from interface: DocParser

Set the feature config for this parser

Specified by:

setFeatureConfig in interface DocParser

Parameters:

featureConfig -

parse

public DocBase parse(Reader reader)
              throws DocException

Description copied from interface: DocParser

Parse a source

Specified by:

parse in interface DocParser

Parameters:

reader - the source reader

Returns:

the parsed document

Throws:

DocException - in case of problems

validateResult

public DocValidationResult validateResult(Reader reader)
                                   throws DocException

Description copied from interface: DocParser

Validate a source

Specified by:

validateResult in interface DocParser

Parameters:

reader - the source reader

Returns:

the result of the validation

Throws:

DocException - in case of problems

validate

public int validate(Reader reader)
             throws DocException

Description copied from interface: DocParser

Validate a source

Specified by:

validate in interface DocParser

Parameters:

reader - the source reader

Returns:

the result of the validation (0 in case of success)

Throws:

DocException - in case of problems

validateVersionResult

public DocValidationResult validateVersionResult(Reader reader)
                                          throws DocException

Description copied from interface: DocParser

Validate a source, it tries to find the xsd version and validate against the specific version

Specified by:

validateVersionResult in interface DocParser

Parameters:

reader - the source reader

Returns:

the result of the validation

Throws:

DocException - in case of problems

validateVersion

public int validateVersion(Reader reader)
                    throws DocException

Description copied from interface: DocParser

Validate a source, it tries to find the xsd version and validate against the specific version

Specified by:

validateVersion in interface DocParser

Parameters:

reader - the source reader

Returns:

the result of the validation as an int (0 in case of success)

Throws:

DocException - in case of problems

validateWorker

protected abstract DocValidationResult validateWorker(Reader reader,
 boolean parseVersion)
                                               throws DocException

Throws:

DocException

parseWorker

protected abstract DocBase parseWorker(Reader reader)
                                throws DocException

Throws:

DocException