org.docgene.parser

Interface DirectoryParser

public interface DirectoryParser

The directory parser interface.

Method Summary

Modifier and Type	Method and Description
void	addError(java.lang.String message) Add an error message
void	addInfo(java.lang.String message) Add an information message
org.docgene.parser.XMLErrorHandler	getErrorHandler() Return the error handler which will be used to create and store errors or informations during the parsing.
ArticlesModel	getModel() Return the Articles Model.
boolean	hasExceptions() Return true if there were exceptions encountered during the parsing.
void	parseDirectories(java.io.File[] dirs) Parse the input directories.
default void	parseDirectoriesAndResolve(java.io.File[] dirs) Parse the input directories, and resolve.
void	resolve() Resolve after parsing the directories.
void	setErrorHandler(org.docgene.parser.XMLErrorHandler errorHandler) Set the error handler which will be used to create and store errors or informations during the parsing.
void	setIndexFile(java.io.File indexFile) Set the index file.
void	setParserExternalHandler(org.docgene.parser.ParserExternalHandler externalHandler) Set the optional parser external handler, which can be fired on events when parsing the wiki
org.docgene.main.ErrorLogger	showParserExceptions() Show error logger.

Method Detail

getModel

ArticlesModel getModel()

Return the Articles Model.

Returns:

the Articles Model

setIndexFile

void setIndexFile(java.io.File indexFile)

Set the index file. The index file can be set if more than one root directory is selected.

Parameters:

indexFile - the index file

setParserExternalHandler

void setParserExternalHandler(org.docgene.parser.ParserExternalHandler externalHandler)

Set the optional parser external handler, which can be fired on events when parsing the wiki

Parameters:

externalHandler - the optional parser external handle

parseDirectoriesAndResolve

default void parseDirectoriesAndResolve(java.io.File[] dirs)

Parse the input directories, and resolve.

Parameters:

dirs - the input directories

parseDirectories

void parseDirectories(java.io.File[] dirs)

Parse the input directories.

Parameters:

dirs - the input directories

resolve

void resolve()

Resolve after parsing the directories.

showParserExceptions

org.docgene.main.ErrorLogger showParserExceptions()

Show error logger. Will be null if there are no exceptions.

Returns:

the error logger. Will be null if there are no exceptions

hasExceptions

boolean hasExceptions()

Return true if there were exceptions encountered during the parsing.

Returns:

true if there were exceptions encountered during the parsing

setErrorHandler

void setErrorHandler(org.docgene.parser.XMLErrorHandler errorHandler)

Set the error handler which will be used to create and store errors or informations during the parsing.

Parameters:

errorHandler - the error handler

getErrorHandler

org.docgene.parser.XMLErrorHandler getErrorHandler()

Return the error handler which will be used to create and store errors or informations during the parsing.

Returns:

the error handler

addInfo

void addInfo(java.lang.String message)

Add an information message

Parameters:

message - the message

addError

void addError(java.lang.String message)

Add an error message

Parameters:

message - the message