org.openptk.structure
Class PlainConverter

java.lang.Object
  org.openptk.structure.Converter
      org.openptk.structure.PlainConverter

All Implemented Interfaces:

ConverterIF

public class PlainConverter
extends Converter

This class supports the conversion of StructureIF data TO Plain Text. Nested data is presented as indented rows.
This Converter does NOT implement the conversion of Plain Text to StructureIF data.

Author:

Scott Fehrman, Sun Microsystems, Inc.

Field Summary

Fields inherited from class org.openptk.structure.Converter

GT, GTE, LT, LTE, NEWLINE, PAD, QUOTE, SEPARATOR

Fields inherited from interface org.openptk.structure.ConverterIF

PROP_CHILDREN, PROP_NAMEVALUE, PROP_VALUE, VALUE_CHILDREN_DISCRETE, VALUE_CHILDREN_LIST, VALUE_NAMEVALUE_COLLAPSED, VALUE_NAMEVALUE_EXPANDED, VALUE_VALUE_MULTI, VALUE_VALUE_SINGLE

Constructor Summary

PlainConverter()
Create a new PlainConverter object.

Method Summary

java.lang.String

encode(StructureIF struct) Convert the Structure data into a Plain Text formated String.

Methods inherited from class org.openptk.structure.Converter

decode, getStructInfo, getStructInfoIds, getStructProperty, getType, handleError, pad, setStructInfo

Methods inherited from class java.lang.Object

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

Constructor Detail

PlainConverter

public PlainConverter()

Create a new PlainConverter object.

Method Detail

encode

public final java.lang.String encode(StructureIF struct)
                              throws ConverterException

Convert the Structure data into a Plain Text formated String.

Specified by:

encode in interface ConverterIF

Overrides:

encode in class Converter

Parameters:

struct - StructureIF of data

Returns:

String Plain Text representation of the data

Throws:

ConverterException