org.geotools.xml.transform
Interface Translator

All Known Implementing Classes:

FeatureTransformer.FeatureTranslator, FeatureTypeTransformer.FeatureTypeTranslator, FilterTransformer.FilterTranslator, GeometryTransformer.GeometryTranslator, TransformerBase.TranslatorSupport

public interface Translator

A Translator is used in an XMLEncoding process by the FeatureTransformer class.

Author:

Ian Schneider

Method Summary

void	abort() Abort any translating activity.
void	encode(Object o) Encode the object.
String	getDefaultNamespace() Get the default URI used by this Translator for encoding.
String	getDefaultPrefix() Get the default prefix used by this Translator for encoding.
NamespaceSupport	getNamespaceSupport() Obtain the namespace prefixes and URIs to be included in the output document.
TransformerBase.SchemaLocationSupport	getSchemaLocationSupport() Gets the location of the schemas used in this translator.

Method Detail

getNamespaceSupport

NamespaceSupport getNamespaceSupport()

Obtain the namespace prefixes and URIs to be included in the output document.

Returns:

An instance of NamespaceSupport.

getDefaultNamespace

String getDefaultNamespace()

Get the default URI used by this Translator for encoding. Optional.

getDefaultPrefix

String getDefaultPrefix()

Get the default prefix used by this Translator for encoding. Optional.

encode

void encode(Object o)
            throws IllegalArgumentException

Encode the object.

Parameters:

o - The Object to encode.

Throws:

IllegalArgumentException - if the Object is not encodeable.

getSchemaLocationSupport

TransformerBase.SchemaLocationSupport getSchemaLocationSupport()

Gets the location of the schemas used in this translator. Optional.

abort

void abort()

Abort any translating activity. This is needed as some translators iterate internally on a data structure. The abort method should silently fail or succeed based upon the state of a translation.