weka.core.xml

Class XMLInstances

java.lang.Object

weka.core.xml.XMLDocument

weka.core.xml.XMLInstances

All Implemented Interfaces:

Serializable, RevisionHandler

public class XMLInstances
extends XMLDocument
implements Serializable

XML representation of the Instances class.

Version:

$Revision: 1.4 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATT_CLASS the class attribute
static String	ATT_FORMAT the format attribute (for date attributes)
static String	ATT_INDEX the index attribute
static String	ATT_MISSING the missing attribute
static String	ATT_TYPE the type attribute
static String	ATT_VERSION the version attribute
static String	ATT_WEIGHT the weight attribute
static String	DOCTYPE the DTD
static String	FILE_EXTENSION The filename extension that should be used for xrff files
protected Instances	m_Instances the underlying Instances
protected int	m_Precision the precision for numbers
static String	TAG_ATTRIBUTE the attribute element
static String	TAG_ATTRIBUTES the attributes element
static String	TAG_BODY the body element
static String	TAG_DATASET the root element
static String	TAG_HEADER the header element
static String	TAG_INSTANCE the instance element
static String	TAG_INSTANCES the data element
static String	TAG_LABEL the label element
static String	TAG_LABELS the labels element
static String	TAG_METADATA the meta-data element
static String	TAG_NOTES the notes element
static String	TAG_PROPERTY the property element
static String	TAG_VALUE the value element
static String	VAL_DATE the value for date
static String	VAL_NOMINAL the value for nominal
static String	VAL_NORMAL the value for normal
static String	VAL_NUMERIC the value for numeric
static String	VAL_RELATIONAL the value for relational
static String	VAL_SPARSE the value for sparse
static String	VAL_STRING the value for string

Fields inherited from class weka.core.xml.XMLDocument

ATT_NAME, DTD_ANY, DTD_AT_LEAST_ONE, DTD_ATTLIST, DTD_CDATA, DTD_DOCTYPE, DTD_ELEMENT, DTD_IMPLIED, DTD_OPTIONAL, DTD_PCDATA, DTD_REQUIRED, DTD_SEPARATOR, DTD_ZERO_OR_MORE, m_Builder, m_DocType, m_Document, m_Factory, m_RootNode, m_Validating, m_XPath, PI, VAL_NO, VAL_YES

Constructor Summary

Constructors

Constructor and Description
XMLInstances() the default constructor
XMLInstances(Instances data) generates the XML structure based on the given data
XMLInstances(Reader reader) generates the Instances directly from the reader containing the XML data.

Method Summary

Modifier and Type	Method and Description
protected void	addAttribute(Element parent, Attribute att) adds the attribute to the XML structure
protected void	addInstance(Element parent, Instance inst) adds the instance to the XML structure
protected Attribute	createAttribute(Element node) creates an Attribute from the given XML node
protected FastVector	createAttributes(Element parent, int[] classIndex) returns a list of generated attributes
protected Instance	createInstance(Instances header, Element parent) creates an Instance from the given XML node
protected Instances	createInstances(Instances header, Element parent) creates Instances from the given XML node
protected FastVector	createLabels(Element parent) returns the labels listed underneath this (nominal) attribute in a FastVector
protected ProtectedProperties	createMetadata(Element parent) returns the metadata, if any available underneath this node, otherwise just null
protected Instances	dataFromXML(Instances header) generates the complete dataset from the XML document
protected void	dataToXML() generates the XML structure from the rows
Instances	getInstances() returns the current instances, either the ones that were set or the ones that were generated from the XML structure.
String	getRevision() Returns the revision string.
protected Instances	headerFromXML() generates the header from the XML document
protected void	headerToXML() generates the XML structure for the header
static void	main(String[] args) takes an XML document as first argument and then outputs the Instances statistics
void	setInstances(Instances data) builds up the XML structure based on the given data
void	setXML(Reader reader) reads the XML structure from the given reader
protected String	validContent(String content) turns all <, > and &into character entities and returns that string.

Methods inherited from class weka.core.xml.XMLDocument

clear, eval, evalBoolean, evalDouble, evalString, findNodes, getBuilder, getChildTags, getChildTags, getContent, getDocType, getDocument, getFactory, getNode, getRootNode, getValidating, newDocument, print, read, read, read, read, setDocType, setDocument, setRootNode, setValidating, toString, toString, write, write, write, write

Methods inherited from class java.lang.Object

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

Field Detail

FILE_EXTENSION

public static String FILE_EXTENSION

The filename extension that should be used for xrff files

TAG_DATASET

public static final String TAG_DATASET

the root element

See Also:

Constant Field Values

TAG_HEADER

public static final String TAG_HEADER

the header element

See Also:

Constant Field Values

TAG_BODY

public static final String TAG_BODY

the body element

See Also:

Constant Field Values

TAG_NOTES

public static final String TAG_NOTES

the notes element

See Also:

Constant Field Values

TAG_ATTRIBUTES

public static final String TAG_ATTRIBUTES

the attributes element

See Also:

Constant Field Values

TAG_ATTRIBUTE

public static final String TAG_ATTRIBUTE

the attribute element

See Also:

Constant Field Values

TAG_LABELS

public static final String TAG_LABELS

the labels element

See Also:

Constant Field Values

TAG_LABEL

public static final String TAG_LABEL

the label element

See Also:

Constant Field Values

TAG_METADATA

public static final String TAG_METADATA

the meta-data element

See Also:

Constant Field Values

TAG_PROPERTY

public static final String TAG_PROPERTY

the property element

See Also:

Constant Field Values

TAG_INSTANCES

public static final String TAG_INSTANCES

the data element

See Also:

Constant Field Values

TAG_INSTANCE

public static final String TAG_INSTANCE

the instance element

See Also:

Constant Field Values

TAG_VALUE

public static final String TAG_VALUE

the value element

See Also:

Constant Field Values

ATT_VERSION

public static final String ATT_VERSION

the version attribute

See Also:

Constant Field Values

ATT_TYPE

public static final String ATT_TYPE

the type attribute

See Also:

Constant Field Values

ATT_FORMAT

public static final String ATT_FORMAT

the format attribute (for date attributes)

See Also:

Constant Field Values

ATT_CLASS

public static final String ATT_CLASS

the class attribute

See Also:

Constant Field Values

ATT_INDEX

public static final String ATT_INDEX

the index attribute

See Also:

Constant Field Values

ATT_WEIGHT

public static final String ATT_WEIGHT

the weight attribute

See Also:

Constant Field Values

ATT_MISSING

public static final String ATT_MISSING

the missing attribute

See Also:

Constant Field Values

VAL_NUMERIC

public static final String VAL_NUMERIC

the value for numeric

See Also:

Constant Field Values

VAL_DATE

public static final String VAL_DATE

the value for date

See Also:

Constant Field Values

VAL_NOMINAL

public static final String VAL_NOMINAL

the value for nominal

See Also:

Constant Field Values

VAL_STRING

public static final String VAL_STRING

the value for string

See Also:

Constant Field Values

VAL_RELATIONAL

public static final String VAL_RELATIONAL

the value for relational

See Also:

Constant Field Values

VAL_NORMAL

public static final String VAL_NORMAL

the value for normal

See Also:

Constant Field Values

VAL_SPARSE

public static final String VAL_SPARSE

the value for sparse

See Also:

Constant Field Values

DOCTYPE

public static final String DOCTYPE

the DTD

m_Precision

protected int m_Precision

the precision for numbers

m_Instances

protected Instances m_Instances

the underlying Instances

Constructor Detail

XMLInstances

public XMLInstances()
             throws Exception

the default constructor

Throws:

Exception - if XML initialization fails

XMLInstances

public XMLInstances(Instances data)
             throws Exception

generates the XML structure based on the given data

Parameters:

data - the data to build the XML structure from

Throws:

Exception - if initialization/generation fails

XMLInstances

public XMLInstances(Reader reader)
             throws Exception

generates the Instances directly from the reader containing the XML data.

Parameters:

reader - the reader for the XML data

Throws:

Exception - if something goes wrong

Method Detail

addAttribute

protected void addAttribute(Element parent,
                            Attribute att)

adds the attribute to the XML structure

Parameters:

parent - the parent node to add the attribute node as child

att - the attribute to add

validContent

protected String validContent(String content)

turns all <, > and &into character entities and returns that string. Necessary for TextNodes.

Parameters:

content - string to convert

Returns:

the valid content string

addInstance

protected void addInstance(Element parent,
                           Instance inst)

adds the instance to the XML structure

Parameters:

parent - the parent node to add the instance node as child

inst - the instance to add

headerToXML

protected void headerToXML()

generates the XML structure for the header

dataToXML

protected void dataToXML()

generates the XML structure from the rows

setInstances

public void setInstances(Instances data)

builds up the XML structure based on the given data

Parameters:

data - data to generate the XML from

getInstances

public Instances getInstances()

returns the current instances, either the ones that were set or the ones that were generated from the XML structure.

Returns:

the current instances

createMetadata

protected ProtectedProperties createMetadata(Element parent)
                                      throws Exception

returns the metadata, if any available underneath this node, otherwise just null

Parameters:

parent - the attribute node

Returns:

the metadata, or null if none found

Throws:

Exception - if generation fails

createLabels

protected FastVector createLabels(Element parent)
                           throws Exception

returns the labels listed underneath this (nominal) attribute in a FastVector

Parameters:

parent - the (nominal) attribute node

Returns:

the label vector

Throws:

Exception - if generation fails

createAttribute

protected Attribute createAttribute(Element node)
                             throws Exception

creates an Attribute from the given XML node

Parameters:

node - the node with the setup

Returns:

the configured Attribute

Throws:

Exception - if generation fails, e.g., due to unknown attribute type

createAttributes

protected FastVector createAttributes(Element parent,
                                      int[] classIndex)
                               throws Exception

returns a list of generated attributes

Parameters:

parent - the attributes node

classIndex - array of length 1 to return the class index, if any

Returns:

the vector with the generated attributes

Throws:

Exception - if generation fails, e.g., due to unknown attribute type

createInstance

protected Instance createInstance(Instances header,
                                  Element parent)
                           throws Exception

creates an Instance from the given XML node

Parameters:

header - the data this instance will belong to

parent - the instance node

Returns:

the configured Instance

Throws:

Exception - if generation fails, e.g., due to unknown attribute type

createInstances

protected Instances createInstances(Instances header,
                                    Element parent)
                             throws Exception

creates Instances from the given XML node

Parameters:

header - the header of this data

parent - the instances node

Returns:

the generated Instances

Throws:

Exception - if generation fails, e.g., due to unknown attribute type

headerFromXML

protected Instances headerFromXML()
                           throws Exception

generates the header from the XML document

Returns:

the generated header

Throws:

Exception - if generation fails

dataFromXML

protected Instances dataFromXML(Instances header)
                         throws Exception

generates the complete dataset from the XML document

Parameters:

header - the header structure

Returns:

the complete dataset

Throws:

Exception - if generation fails

setXML

public void setXML(Reader reader)
            throws Exception

reads the XML structure from the given reader

Parameters:

reader - the reader to get the XML from

Throws:

Exception - if

getRevision

public String getRevision()

Returns the revision string.

Specified by:

getRevision in interface RevisionHandler

Overrides:

getRevision in class XMLDocument

Returns:

the revision

main

public static void main(String[] args)

takes an XML document as first argument and then outputs the Instances statistics

Parameters:

args - the commandline options