jade.content.lang

Class StringCodec

java.lang.Object

jade.content.lang.Codec

jade.content.lang.StringCodec

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

SimpleSLCodec, SLCodec

public abstract class StringCodec
extends Codec

Base class for content language codecs that transform AbsContentElements to/from sequences of strings

Author:

Giovanni Caire - TILAB

See Also:

Serialized Form

Nested Class Summary

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

Codec.CodecException

Field Summary

Fields inherited from class jade.content.lang.Codec

UNNAMEDPREFIX

Constructor Summary

Constructors

Constructor and Description
StringCodec(java.lang.String name) Construct a StringCodec object with the given name

Method Summary

Modifier and Type	Method and Description
abstract AbsContentElement	decode(Ontology ontology, java.lang.String content) Decodes the content to an abstract description using a given ontology.
abstract AbsContentElement	decode(java.lang.String content) Decodes the content to an abstract description.
abstract java.lang.String	encode(AbsContentElement content) Encodes a content into a string.
abstract java.lang.String	encode(Ontology ontology, AbsContentElement content) Encodes a content into a string using a given ontology.

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

Constructor Detail

StringCodec

public StringCodec(java.lang.String name)

Construct a StringCodec object with the given name

Method Detail

encode

public abstract java.lang.String encode(AbsContentElement content)
                                 throws Codec.CodecException

Encodes a content into a string.

Parameters:

content - the content as an abstract descriptor.

Returns:

the content as a string.

Throws:

CodecException

Codec.CodecException

encode

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

Encodes a content into a string using a given ontology.

Parameters:

ontology - the ontology

content - the content as an abstract descriptor.

Returns:

the content as a string.

Throws:

CodecException

Codec.CodecException

decode

public abstract AbsContentElement decode(java.lang.String content)
                                  throws Codec.CodecException

Decodes the content to an abstract description.

Parameters:

content - the content as a string.

Returns:

the content as an abstract description.

Throws:

CodecException

Codec.CodecException

decode

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

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

Parameters:

ontology - the ontology.

content - the content as a string.

Returns:

the content as an abstract description.

Throws:

CodecException

Codec.CodecException