Package adams.core.io.filecomplete

Class XML

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.core.io.filecomplete.AbstractFileCompleteCheck

adams.core.io.filecomplete.XML

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Serializable

public class XML
extends AbstractFileCompleteCheck

Checks whether the XML can be parsed.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_ExpandEntityReferences	Specifies that the parser produced by this code will expand entity reference nodes.
protected boolean	m_NameSpaceAware	whether the parser is namespace aware.
protected boolean	m_Validating	whether the parser is validating or not.
protected boolean	m_XIncludeAware	Set state of XInclude processing.

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
XML()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
String	expandEntityReferencesTipText()	Returns the tip text for this property.
boolean	getExpandEntityReferences()	Returns whether a parser expands entity references.
boolean	getNameSpaceAware()	Returns whether a namespace aware parser used.
boolean	getValidating()	Returns whether a validating parser is used.
boolean	getXIncludeAware()	Returns whether a X-include aware parser is used.
String	globalInfo()	Returns a string describing the object.
boolean	isComplete(byte[] buffer)	Checks whether the byte buffer is complete.
boolean	isComplete(File file)	Checks whether the file is complete.
String	nameSpaceAwareTipText()	Returns the tip text for this property.
void	setExpandEntityReferences(boolean value)	Sets whether to expand entity references.
void	setNameSpaceAware(boolean value)	Sets whether to use a namespace aware parser.
void	setValidating(boolean value)	Sets whether to use a validating parser.
void	setXIncludeAware(boolean value)	Sets whether to use a X-include aware parser.
String	validatingTipText()	Returns the tip text for this property.
String	XIncludeAwareTipText()	Returns the tip text for this property.

Methods inherited from class adams.core.io.filecomplete.AbstractFileCompleteCheck

read

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_Validating

protected boolean m_Validating

whether the parser is validating or not.

m_NameSpaceAware

protected boolean m_NameSpaceAware

whether the parser is namespace aware.

m_XIncludeAware

protected boolean m_XIncludeAware

Set state of XInclude processing.

m_ExpandEntityReferences

protected boolean m_ExpandEntityReferences

Specifies that the parser produced by this code will expand entity reference nodes.

Constructor Detail

XML

public XML()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setValidating

public void setValidating(boolean value)

Sets whether to use a validating parser.

Parameters:

value - true if to use validating parser

getValidating

public boolean getValidating()

Returns whether a validating parser is used.

Returns:

true if validating parser

validatingTipText

public String validatingTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setNameSpaceAware

public void setNameSpaceAware(boolean value)

Sets whether to use a namespace aware parser.

Parameters:

value - true if to use namespace aware parser

getNameSpaceAware

public boolean getNameSpaceAware()

Returns whether a namespace aware parser used.

Returns:

true if namespace aware

nameSpaceAwareTipText

public String nameSpaceAwareTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setXIncludeAware

public void setXIncludeAware(boolean value)

Sets whether to use a X-include aware parser.

Parameters:

value - true if to use X-include aware parser

getXIncludeAware

public boolean getXIncludeAware()

Returns whether a X-include aware parser is used.

Returns:

true if X-include aware parser

XIncludeAwareTipText

public String XIncludeAwareTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setExpandEntityReferences

public void setExpandEntityReferences(boolean value)

Sets whether to expand entity references.

Parameters:

value - true if to expand entity references

getExpandEntityReferences

public boolean getExpandEntityReferences()

Returns whether a parser expands entity references.

Returns:

true if parser expands entity references

expandEntityReferencesTipText

public String expandEntityReferencesTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

isComplete

public boolean isComplete(byte[] buffer)

Checks whether the byte buffer is complete.

Specified by:

isComplete in class AbstractFileCompleteCheck

Parameters:

buffer - the buffer to check

Returns:

true if complete

isComplete

public boolean isComplete(File file)

Checks whether the file is complete.

Specified by:

isComplete in class AbstractFileCompleteCheck

Parameters:

file - the file to check

Returns:

true if complete