Package com.inductiveautomation.ignition.common.xmlserialization.simple

Class Element

java.lang.Object

com.inductiveautomation.ignition.common.xmlserialization.simple.Element

Direct Known Subclasses:

ArrayElement, BasicHistoricalRecord.HistoricalRecordXmlReader.Col, BasicHistoricalRecord.HistoricalRecordXmlReader.Record, BasicHistoricalRecord.HistoricalRecordXmlReader.Row, DatasetElement, DatasetElement.ColumnElement, HistoricalDataXmlReader.DataTransactionElement, HistoryFlavor.Base64XmlReader.Base64Element, StringValueElement, TagHistoryFlavor.TagXmlImportReader.RetirementListElement, TagHistoryFlavor.TagXmlImportReader.ScanclassSet, TagHistoryFlavor.TagXmlImportReader.TagElement, TagHistoryFlavor.TagXmlImportReader.TagValueElement, TagXMLImporter.TagXMLReader.AlarmConfigElement, TagXMLImporter.TagXMLReader.EntryElement, TagXMLImporter.TagXMLReader.EventElement, TagXMLImporter.TagXMLReader.EventScriptsElement, TagXMLImporter.TagXMLReader.ParametersElement, TagXMLImporter.TagXMLReader.PermissionModelElement, TagXMLImporter.TagXMLReader.PropertyBasedElement, TagXMLImporter.TagXMLReader.PropertyElement, TagXMLImporter.TagXMLReader.QueryParametersElement, TagXMLImporter.TagXMLReader.TagsElement

public abstract class Element
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Element.ValidationResult

Field Summary

Fields

Modifier and Type	Field	Description
protected String	name

Constructor Summary

Constructors

Constructor	Description
Element()

Method Summary

Modifier and Type	Method	Description
abstract void	addChild(Element child)
Locale	getLocale()
String	getName()
Object	getValue()
Class<? extends Element>	resolveType(String name)	This allows complex elements to return their own implementation or definitions for element types.
void	setAttributes(Attributes attr)
void	setLocale(Locale locale)
void	setName(String value)
void	setRawValue(String value)
Element.ValidationResult	validate()

Methods inherited from class java.lang.Object

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

Field Details

name

protected String name

Constructor Details

Element

public Element()

Method Details

setAttributes

public void setAttributes(Attributes attr)
                   throws Exception

Throws:

Exception

getName

public String getName()

setName

public void setName(String value)

getValue

public Object getValue()

setRawValue

public void setRawValue(String value)
                 throws Exception

Throws:

Exception

setLocale

public void setLocale(Locale locale)

getLocale

public Locale getLocale()

addChild

public abstract void addChild(Element child)
                       throws Exception

Throws:

Exception

validate

public Element.ValidationResult validate()

resolveType

public Class<? extends Element> resolveType(String name)

This allows complex elements to return their own implementation or definitions for element types. When a new element is encountered, the system works its way up through the current stack, and finally ends up at the types registered on the reader. This should return null if the element doesn't provide a custom type for the given name.
The class returned can be a non-static class. In that case, it will get instantiated against the object returning it.

Parameters:

name - the lower cased element name.

Returns:

a class that represents the element, or null if unknown.