net.charlesames.utility.io
Interface XmlFileDocument

All Superinterfaces:

FileDocument

All Known Implementing Classes:

Ensemble, MidiFile, Score

public interface XmlFileDocument
extends FileDocument

Interface for entities which persist their content in XML files.

Author:

Charles Ames

Method Summary

java.util.List<XmlNodeError>	getErrors() Get the collection of errors generated during the most recent file load.
java.lang.String	getXmlDefaultNamespace() Get the XML default namespace.
java.lang.String	getXmlSchemaLocation() Get the schema location.
void	logError(org.w3c.dom.Node node, java.lang.String message) Handle an error encountered while loading this document.

Methods inherited from interface net.charlesames.utility.io.FileDocument

dispose, getFile, getLoadDate, isDirty, load, makeDirty, save, setFile

Method Detail

getXmlDefaultNamespace

java.lang.String getXmlDefaultNamespace()

Get the XML default namespace.

Returns:

The XML default namespace.

getXmlSchemaLocation

java.lang.String getXmlSchemaLocation()

Get the schema location.

Returns:

The schema location.

getErrors

java.util.List<XmlNodeError> getErrors()

Get the collection of errors generated during the most recent file load.

Returns:

The collection of errors generated during the most recent file load.

logError

void logError(org.w3c.dom.Node node,
              java.lang.String message)

Handle an error encountered while loading this document.

Parameters:

node - The XML node where this error was detected.

message - A text string describing the error.