de.esprit.appsuite.nio.ndf

Class NdfHandler

java.lang.Object

de.esprit.appsuite.nio.ndf.NdfHandler

All Implemented Interfaces:

NdfConstants, NdfParseControl, SimpleLogSupport

Direct Known Subclasses:

AppDescriptorHandler, AppDescriptorLaunchPrefsHandler, AppHandler, AppLaunchPrefsHandler, AppVersionHandler, CredentialHandler, DatabaseConfigHandler, DefaultUserManager.MyUserHandler, DumpingNdfHandler, GroupHandler, GroupMemberHandler, LicenseHandler, LoggingNdfHandler, NetworkConfigHandler, PermissionConfigHandler, TimstampHandler

public abstract class NdfHandler
extends java.lang.Object
implements SimpleLogSupport, NdfParseControl, NdfConstants

The NdfHandler is notified by the NdfParser about all structures and properties found during parsing. All callback methods are implemented but do nothing. Subclasses may override the according methods in order to interpret or collect the data as needed.

Author:

Rainer Buesch

Field Summary

Fields inherited from interface de.esprit.appsuite.nio.ndf.NdfConstants

allowedInNames, blockCommentChar, booleanFalseChar, booleanFalseLiteral, booleanTrueChar, booleanTrueLiteral, currentNdfDocVersion, defaultTextEndChar, defaultTextParagraphChar, lineCommentChar, ndfDocAuthorKey, ndfDocCreatedKey, ndfDocEncodingKey, ndfDocTypeKey, ndfDocVersionKey, nullLiteral, quotingBreakCodes, standardBreakCodes, structureChar, textValueBreakCodes, validTextBreakSymbols

Constructor Summary

Constructors

Constructor and Description
NdfHandler()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	acceptDocumentVersion(java.lang.String documentVersion) Allows for breaking parsing if document-version and parser-version do not match.
protected void	checkDocumentType(java.lang.String expectedDocType) Checks whether the document has got the expected document type (ndfDocType property).
void	doneArray(NdfStructure struct) Called when an array structure is done.
void	doneDocument(NdfStructure struct) Called when document parsing has finished.
void	doneList(NdfStructure struct) Called when a list structure is done.
void	doneObject(NdfStructure struct) Called when an object structure is done.
void	doneTable(NdfStructure struct) Called when a table structure is done.
void	doneText(NdfStructure struct) Called when a TEXT structure is done.
void	foundArrayValue(NdfStructure struct, int dimension, int index, AsciiWord data) Called when an array value was found within an array structure.
void	foundArrayValue(NdfStructure struct, int dimension, int index, java.lang.String value) Called when an array value was found within an array structure.
void	foundListValue(NdfStructure struct, AsciiWord data) Called when a list value was found within a list structure.
void	foundListValue(NdfStructure struct, java.lang.String value) Called when a list value was found within a list structure.
void	foundProperties(NdfStructure struct, NdfProperties props) Called when properties are found on top level.
void	foundTableCell(NdfStructure struct, int rowIndex, int columnIndex, AsciiWord data) Called when a table cell value was found within a table structure.
void	foundTableRow(NdfStructure struct, int rowIndex, NdfProperties props) Called when a table row was found within a table structure.
void	foundTableRow(NdfStructure struct, int rowIndex, java.lang.String[] data) Called when a table row was found within a table structure.
void	foundText(NdfStructure struct, int paragraphIndex, java.util.List<java.lang.String> lines) Notifies about text-lines found within a TEXT structure.
void	foundText(NdfStructure struct, java.lang.String text) Notifies about the text found within a TEXT structure.
int	getCurrentNestingLevel() Returns the current nesting level.
NdfStructure	getCurrentStructure() Returns the NdfStructure which is currently being parsed.
java.lang.String	getDocAuthor()
java.sql.Timestamp	getDocCreated()
java.lang.String	getDocEncoding()
java.lang.String	getDocType()
java.lang.String	getDocVersion()
FileInfo	getFileInfo()
int	getLineNumber()
LogChannel	getLogChannel()
int	getMaxNestingLevel() Returns the maximum nesting level reached during parsing.
boolean	isLogDebug()
boolean	isLogVerbose()
void	logDebug(java.lang.String message)
void	logDump(java.lang.String message)
void	logError(java.lang.String message)
void	logError(java.lang.String message, java.lang.Exception e)
void	logFatal(java.lang.String message, java.lang.Exception e)
void	logInfo(java.lang.String message)
void	logVerbose(java.lang.String message)
void	logWarning(java.lang.String message)
void	setLogChannel(LogChannel logCh)
NotifyArrayValue	startArray(NdfStructure struct, NdfProperties props, int[] dimensions) Called when an array structure was found.
void	startDocument(NdfStructure struct, NdfProperties headerProps) Called when document parsing is started.
NotifyListValue	startList(NdfStructure struct, NdfProperties props) Called when a list structure was found.
void	startObject(NdfStructure struct, NdfProperties props) Called when an object structure was detected.
NotifyTableValue	startTable(NdfStructure struct, NdfProperties props, java.lang.String[] columns) Called when a table structure was found.
NotifyText	startText(NdfStructure struct, NdfProperties props) Called when a TEXT structure was found.

Methods inherited from class java.lang.Object

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

Constructor Detail

NdfHandler

public NdfHandler()

Method Detail

getDocVersion

public java.lang.String getDocVersion()

getDocEncoding

public java.lang.String getDocEncoding()

getDocAuthor

public java.lang.String getDocAuthor()

getDocType

public java.lang.String getDocType()

getDocCreated

public java.sql.Timestamp getDocCreated()
                                 throws java.text.ParseException

Throws:

java.text.ParseException

startDocument

public void startDocument(NdfStructure struct,
                 NdfProperties headerProps)
                   throws java.lang.Exception

Called when document parsing is started. Note that the document header properties are already read before this call.

Parameters:

headerProps - the header properties found in the document

Throws:

java.lang.Exception

doneDocument

public void doneDocument(NdfStructure struct)
                  throws java.lang.Exception

Called when document parsing has finished.

Throws:

java.lang.Exception

foundProperties

public void foundProperties(NdfStructure struct,
                   NdfProperties props)
                     throws java.lang.Exception

Called when properties are found on top level. Note that all properties on deeper levels obtain to the according structures and thus are passed to them.

Throws:

java.lang.Exception

startObject

public void startObject(NdfStructure struct,
               NdfProperties props)
                 throws java.lang.Exception

Called when an object structure was detected.

Throws:

java.lang.Exception

doneObject

public void doneObject(NdfStructure struct)
                throws java.lang.Exception

Called when an object structure is done.

Throws:

java.lang.Exception

startText

public NotifyText startText(NdfStructure struct,
                   NdfProperties props)
                     throws java.lang.Exception

Called when a TEXT structure was found. Note that text is stuffed which means: leading and trailing white spaces are removed and multiple white spaces are reduced to a single one. Empty lines are ignored. If the lineFeedBreak symbol is found it is replaced by a '\n' character. The mandatory textEndBreakSymbol stops reading text.

Throws:

java.lang.Exception

foundText

public void foundText(NdfStructure struct,
             int paragraphIndex,
             java.util.List<java.lang.String> lines)
               throws java.lang.Exception

Notifies about text-lines found within a TEXT structure. Note that the line-feed symbols are represented by empty lines in the passed list.

Throws:

java.lang.Exception

foundText

public void foundText(NdfStructure struct,
             java.lang.String text)
               throws java.lang.Exception

Notifies about the text found within a TEXT structure. Note that the text is stuffed which means: leading and trailing white spaces are removed and multiple white spaces are reduced to a single one. Note also that the LF symbols (line-feeds) are represented by '\n' characters in the passed String.

Throws:

java.lang.Exception

doneText

public void doneText(NdfStructure struct)
              throws java.lang.Exception

Called when a TEXT structure is done.

Throws:

java.lang.Exception

startTable

public NotifyTableValue startTable(NdfStructure struct,
                          NdfProperties props,
                          java.lang.String[] columns)
                            throws java.lang.Exception

Called when a table structure was found. The return value of this method defines which type of notification takes place and thus defines which method needs to be overridden in order to receive the table value notification.

• NotifyTableValue.AS_PROPERTIES
  causes notification by properties calling foundTableRow(NdfStructure, int, NdfProperties)
  this is the default way of notification.
• NotifyTableValue.AS_STRING_ARRAY
  causes notification by String[] calling foundTableRow(NdfStructure, int, String[])
• NotifyTableValue.AS_BUFFERED_WORD
  causes notification by AsciiWord calling foundTableCell(NdfStructure, int, int, AsciiWord)
  This is the fastest way of notification, but it works only for pure number values.

Throws:

java.lang.Exception

foundTableRow

public void foundTableRow(NdfStructure struct,
                 int rowIndex,
                 java.lang.String[] data)
                   throws java.lang.Exception

Called when a table row was found within a table structure. This method is called in NotifyTableValue.AS_STRING_ARRAY notification mode. It is quite expensive because it parses values the same way as property values.

Throws:

java.lang.Exception

foundTableRow

public void foundTableRow(NdfStructure struct,
                 int rowIndex,
                 NdfProperties props)
                   throws java.lang.Exception

Called when a table row was found within a table structure. This method is called in NotifyTableValue.AS_PROPERTIES notification mode. It is quite expensive because it parses values the same way as property values. But it provides the convenience to extract values readily converted to the desired data type.

Throws:

java.lang.Exception

foundTableCell

public void foundTableCell(NdfStructure struct,
                  int rowIndex,
                  int columnIndex,
                  AsciiWord data)
                    throws java.lang.Exception

Called when a table cell value was found within a table structure. This method is called in NotifyTableValue.AS_BUFFERED_WORD notification mode. It is very fast but does no interpretation on the read words at all. It does also NOT support quoting of values and thus can only be used for numeric values. For fast data conversion use data.asDouble(), data.asInt() etc. Note that this method is called for each cell value in a table row.

Throws:

java.lang.Exception

doneTable

public void doneTable(NdfStructure struct)
               throws java.lang.Exception

Called when a table structure is done.

Throws:

java.lang.Exception

startList

public NotifyListValue startList(NdfStructure struct,
                        NdfProperties props)
                          throws java.lang.Exception

Called when a list structure was found. The return value of this method defines which type of notification takes place and thus defines which method needs to be overridden in order to receive the list value notification.

• NotifyListValue.AS_STRING
  causes notification by String calling foundListValue(NdfStructure, String)
• NotifyListValue.AS_BUFFERED_WORD
  causes notification by AsciiWord calling foundListValue(NdfStructure, AsciiWord)
  This is the fastest way of notification, but it works only for pure number values.

Throws:

java.lang.Exception

foundListValue

public void foundListValue(NdfStructure struct,
                  java.lang.String value)
                    throws java.lang.Exception

Called when a list value was found within a list structure. This method is called in NotifyListValue.AS_STRING notification mode. It is quite expensive because it parses values the same way as property values.

Throws:

java.lang.Exception

foundListValue

public void foundListValue(NdfStructure struct,
                  AsciiWord data)
                    throws java.lang.Exception

Called when a list value was found within a list structure. This method is called in NotifyListValue.AS_BUFFERED_WORD notification mode. It is very fast but does no interpretation on the read words at all. For fast data conversion use data.asDouble(), data.asInt() etc.

Throws:

java.lang.Exception

doneList

public void doneList(NdfStructure struct)
              throws java.lang.Exception

Called when a list structure is done.

Throws:

java.lang.Exception

startArray

public NotifyArrayValue startArray(NdfStructure struct,
                          NdfProperties props,
                          int[] dimensions)
                            throws java.lang.Exception

Called when an array structure was found. The return value of this method defines which type of notification takes place and thus defines which method needs to be overridden in order to receive the array value notification.

• NotifyArrayValue.AS_STRING
  causes notification by String calling foundArrayValue(NdfStructure, int, int, String)
• NotifyArrayValue.AS_BUFFERED_WORD
  causes notification by AsciiWord calling foundArrayValue(NdfStructure, int, int, AsciiWord)
  This is the fastest way of notification, but it works only for pure number values.

Throws:

java.lang.Exception

foundArrayValue

public void foundArrayValue(NdfStructure struct,
                   int dimension,
                   int index,
                   java.lang.String value)
                     throws java.lang.Exception

Called when an array value was found within an array structure. This method is called in NotifyArrayValue.AS_STRING notification mode. It is quite expensive because it parses values the same way as property values.

Throws:

java.lang.Exception

foundArrayValue

public void foundArrayValue(NdfStructure struct,
                   int dimension,
                   int index,
                   AsciiWord data)
                     throws java.lang.Exception

Called when an array value was found within an array structure. This method is called in NotifyArrayValue.AS_BUFFERED_WORD notification mode. It is very fast but does no interpretation on the read words at all. For fast data conversion use data.asDouble(), data.asInt() etc.

Throws:

java.lang.Exception

doneArray

public void doneArray(NdfStructure struct)
               throws java.lang.Exception

Called when an array structure is done.

Throws:

java.lang.Exception

checkDocumentType

protected final void checkDocumentType(java.lang.String expectedDocType)
                                throws java.lang.Exception

Checks whether the document has got the expected document type (ndfDocType property).

Throws:

java.lang.Exception

acceptDocumentVersion

public boolean acceptDocumentVersion(java.lang.String documentVersion)

Allows for breaking parsing if document-version and parser-version do not match.

getCurrentStructure

public final NdfStructure getCurrentStructure()

Returns the NdfStructure which is currently being parsed.

Specified by:

getCurrentStructure in interface NdfParseControl

getCurrentNestingLevel

public final int getCurrentNestingLevel()

Description copied from interface: NdfParseControl

Returns the current nesting level. This level increases each time an OBJECT structure contains another structure. It decreases when parsing of the sub-structure is done.

Specified by:

getCurrentNestingLevel in interface NdfParseControl

getMaxNestingLevel

public final int getMaxNestingLevel()

Returns the maximum nesting level reached during parsing.

Specified by:

getMaxNestingLevel in interface NdfParseControl

getFileInfo

public final FileInfo getFileInfo()

getLineNumber

public final int getLineNumber()

getLogChannel

public final LogChannel getLogChannel()

Specified by:

getLogChannel in interface SimpleLogSupport

setLogChannel

public final void setLogChannel(LogChannel logCh)

Specified by:

setLogChannel in interface SimpleLogSupport

isLogDebug

public final boolean isLogDebug()

Specified by:

isLogDebug in interface SimpleLogSupport

isLogVerbose

public final boolean isLogVerbose()

Specified by:

isLogVerbose in interface SimpleLogSupport

logDebug

public final void logDebug(java.lang.String message)

Specified by:

logDebug in interface SimpleLogSupport

logDump

public final void logDump(java.lang.String message)

Specified by:

logDump in interface SimpleLogSupport

logError

public final void logError(java.lang.String message,
            java.lang.Exception e)

Specified by:

logError in interface SimpleLogSupport

logError

public final void logError(java.lang.String message)

Specified by:

logError in interface SimpleLogSupport

logFatal

public final void logFatal(java.lang.String message,
            java.lang.Exception e)

Specified by:

logFatal in interface SimpleLogSupport

logInfo

public final void logInfo(java.lang.String message)

Specified by:

logInfo in interface SimpleLogSupport

logVerbose

public final void logVerbose(java.lang.String message)

Specified by:

logVerbose in interface SimpleLogSupport

logWarning

public final void logWarning(java.lang.String message)

Specified by:

logWarning in interface SimpleLogSupport