ch.elexis.exchange.elements
Class XChangeElement

java.lang.Object
  ch.elexis.exchange.elements.XChangeElement

Direct Known Subclasses:

AddressElement, AnalysesElement, AnamnesisElement, ConnectionElement, ContactElement, ContactRefElement, ContactsElement, DocumentElement, DocumentsElement, EpisodeElement, EpisodeRefElement, FindingElement, InsuranceElement, MarkupElement, MedicalElement, MedicationElement, MedicationsElement, MetaElement, RecordElement, RecordsElement, ResultElement, RiskElement, RisksElement, ServiceBlockElement, ServiceBlocksElement, ServiceElement, XidElement, XidElement.Identity

public abstract class XChangeElement
extends java.lang.Object

Base class for all xChange Elements

Author:

gerry

Nested Class Summary

static class

XChangeElement.FORMAT Format for text representation of the element contents

Field Summary

static java.lang.String	ATTR_DATE
static java.lang.String	ATTR_ID
static int	FORMAT_NOT_SUPPORTED
static int	OK

Constructor Summary

XChangeElement()

Method Summary

void	add(XChangeElement el)
XChangeElement	asExporter(XChangeExporter sender)
XChangeElement	asImporter(XChangeImporter reader, Element el)
java.lang.String	getAttr(java.lang.String name) return an attribute value of the underlying element.
XChangeElement	getChild(java.lang.String name, java.lang.Class<? extends XChangeElement> clazz)
java.util.List<? extends XChangeElement>	getChildren(java.lang.String name, java.lang.Class<? extends XChangeElement> clazz) FInd all children of a specified subclass of XChangeElement with a specified element name
XChangeContainer	getContainer()
Element	getElement()
java.lang.String	getID()
XChangeImporter	getReader()
XChangeExporter	getSender()
XidElement	getXid()
abstract java.lang.String	getXMLName()
void	setAttribute(java.lang.String attr, java.lang.String value)
void	setDefaultXid(java.lang.String id) append a XID that consists solely of the local identity id
void	setElement(Element e)
void	setReader(XChangeImporter reader)
void	setWriter(XChangeExporter writer)
Result<java.lang.String>	toString(XChangeElement.FORMAT format) create a string representation of this Element.

Methods inherited from class java.lang.Object

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

Field Detail

ATTR_ID

public static final java.lang.String ATTR_ID

See Also:

Constant Field Values

ATTR_DATE

public static final java.lang.String ATTR_DATE

See Also:

Constant Field Values

OK

public static final int OK

See Also:

Constant Field Values

FORMAT_NOT_SUPPORTED

public static final int FORMAT_NOT_SUPPORTED

See Also:

Constant Field Values

Constructor Detail

XChangeElement

public XChangeElement()

Method Detail

asImporter

public XChangeElement asImporter(XChangeImporter reader,
                                 Element el)

asExporter

public XChangeElement asExporter(XChangeExporter sender)

getElement

public Element getElement()

setElement

public void setElement(Element e)

setReader

public void setReader(XChangeImporter reader)

setWriter

public void setWriter(XChangeExporter writer)

getContainer

public XChangeContainer getContainer()

getReader

public XChangeImporter getReader()

getSender

public XChangeExporter getSender()

getXMLName

public abstract java.lang.String getXMLName()

getAttr

public java.lang.String getAttr(java.lang.String name)

return an attribute value of the underlying element.

Parameters:

name - name of the atribute

Returns:

the value which can be an empty String but is never null.

setDefaultXid

public void setDefaultXid(java.lang.String id)

append a XID that consists solely of the local identity id

Parameters:

id -

getID

public java.lang.String getID()

add

public void add(XChangeElement el)

getXid

public XidElement getXid()

getChildren

public java.util.List<? extends XChangeElement> getChildren(java.lang.String name,
                                                            java.lang.Class<? extends XChangeElement> clazz)

FInd all children of a specified subclass of XChangeElement with a specified element name

Parameters:

name -

clazz -

Returns:

a possibly empty list or null on errors

getChild

public XChangeElement getChild(java.lang.String name,
                               java.lang.Class<? extends XChangeElement> clazz)

toString

public Result<java.lang.String> toString(XChangeElement.FORMAT format)

create a string representation of this Element. Subclasses should override

Parameters:

format - one of gthe FORMAT constants

Returns:

a String representation if the format was supported. The default implementation returns always "Format not supported"

setAttribute

public void setAttribute(java.lang.String attr,
                         java.lang.String value)