Package jade.content.lang.xml

Class XMLCodec

java.lang.Object

jade.content.lang.Codec

jade.content.lang.StringCodec

jade.content.lang.xml.XMLCodec

All Implemented Interfaces:

Serializable, Serializable

public class XMLCodec
extends StringCodec

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class jade.content.lang.Codec

Codec.CodecException

Field Summary

Fields

Modifier and Type	Field	Description
static String	AGGREGATE_ATTR
static String	AGGREGATE_TYPE_ATTR
static String	BINARY_STARTER
static String	NAME
static String	PRIMITIVE_TAG
static String	TYPE_ATTR
static String	VALUE_ATTR

Fields inherited from class jade.content.lang.Codec

UNNAMEDPREFIX

Constructor Summary

Constructors

Constructor	Description
XMLCodec()	Create an XMLCodec that preserves java primitive types (long, int, float, double).
XMLCodec(boolean preserveJavaTypes)	Create an XMLCodec specifying whether or not java primitive types (long, int, float, double) must be preserved.

Method Summary

Modifier and Type	Method	Description
AbsContentElement	decode(Ontology ontology, String content)	.
AbsContentElement	decode(String content)	Decodes the content to an abstract description.
AbsObject	decodeAbsObject(Ontology ontology, String xml)
Object	decodeObject(Ontology ontology, String xml)	Decode a generic ontological entity from an XML form
String	encode(AbsContentElement content)	Encodes a content into a string.
String	encode(Ontology ontology, AbsContentElement content)	Encodes a content into a string using a given ontology.
String	encodeAbsObject(Ontology ontology, AbsObject abs, boolean indent)
String	encodeObject(Ontology ontology, Object obj, boolean indent)	Encode a generic ontological entity in XML form

Methods inherited from class jade.content.lang.Codec

getInnerOntology, getName

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

PRIMITIVE_TAG

public static final String PRIMITIVE_TAG

See Also:

Constant Field Values

VALUE_ATTR

public static final String VALUE_ATTR

See Also:

Constant Field Values

TYPE_ATTR

public static final String TYPE_ATTR

See Also:

Constant Field Values

AGGREGATE_ATTR

public static final String AGGREGATE_ATTR

See Also:

Constant Field Values

AGGREGATE_TYPE_ATTR

public static final String AGGREGATE_TYPE_ATTR

See Also:

Constant Field Values

BINARY_STARTER

public static final String BINARY_STARTER

See Also:

Constant Field Values

Constructor Detail

XMLCodec

public XMLCodec()

Create an XMLCodec that preserves java primitive types (long, int, float, double). This is achieved by encoding long values as L and float values as XMLCodec(null)

XMLCodec

public XMLCodec(boolean preserveJavaTypes)

Create an XMLCodec specifying whether or not java primitive types (long, int, float, double) must be preserved.

Method Detail

encode

public String encode(AbsContentElement content)
              throws Codec.CodecException

Encodes a content into a string.

Specified by:

encode in class StringCodec

Parameters:

content - the content as an abstract descriptor.

Returns:

the content as a string.

Throws:

Codec.CodecException

encode

public String encode(Ontology ontology,
                     AbsContentElement content)
              throws Codec.CodecException

Encodes a content into a string using a given ontology.

Specified by:

encode in class StringCodec

Parameters:

ontology - the ontology

content - the content as an abstract descriptor.

Returns:

the content as a string.

Throws:

Codec.CodecException

encodeAbsObject

public String encodeAbsObject(Ontology ontology,
                              AbsObject abs,
                              boolean indent)
                       throws Codec.CodecException,
                              OntologyException

Throws:

Codec.CodecException

OntologyException

encodeObject

public String encodeObject(Ontology ontology,
                           Object obj,
                           boolean indent)
                    throws Codec.CodecException,
                           OntologyException

Encode a generic ontological entity in XML form

Throws:

Codec.CodecException

OntologyException

decode

public AbsContentElement decode(String content)
                         throws Codec.CodecException

Decodes the content to an abstract description.

Specified by:

decode in class StringCodec

Parameters:

content - the content as a string.

Returns:

the content as an abstract description.

Throws:

Codec.CodecException

decode

public AbsContentElement decode(Ontology ontology,
                                String content)
                         throws Codec.CodecException

. Decodes the content to an abstract description using a given ontology.

Specified by:

decode in class StringCodec

Parameters:

ontology - the ontology.

content - the content as a string.

Returns:

the content as an abstract description.

Throws:

Codec.CodecException

decodeAbsObject

public AbsObject decodeAbsObject(Ontology ontology,
                                 String xml)
                          throws Codec.CodecException,
                                 OntologyException

Throws:

Codec.CodecException

OntologyException

decodeObject

public Object decodeObject(Ontology ontology,
                           String xml)
                    throws Codec.CodecException,
                           OntologyException

Decode a generic ontological entity from an XML form

Throws:

Codec.CodecException

OntologyException