org.writersforge.catalan.transform.text
Class FromAsciiConverter

java.lang.Object
  org.writersforge.catalan.transform.BaseNodeProcessor
      org.writersforge.catalan.transform.text.FromAsciiConverter

All Implemented Interfaces:

org.writersforge.bellows.traverse.NodeProcessor

public class FromAsciiConverter

extends BaseNodeProcessor

A packed ASCII field processor which explodes a packed ASCII data node into a collection of Java objects.

Author:

jsheets

See Also:

AsciiFieldManager

Constructor Summary

FromAsciiConverter(org.writersforge.bellows.Datum xml)
Creates a new instance of FromAsciiConverter from the XML spec.

FromAsciiConverter(java.lang.String fieldSpec)
Creates a new instance of FromAsciiConverter.

Method Summary

void	end(java.util.List nodes) Ends the current traversal.
java.util.List	processNode(java.lang.Object node) Process a single node.
java.lang.String	toString() Convert this object to a String value.

Methods inherited from class org.writersforge.catalan.transform.BaseNodeProcessor

addLeftover, getLeftovers, getNodes, start

Methods inherited from class java.lang.Object

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

Constructor Detail

FromAsciiConverter

public FromAsciiConverter(org.writersforge.bellows.Datum xml)

Creates a new instance of FromAsciiConverter from the XML spec.

Parameters:

xml - XML initializing spec

FromAsciiConverter

public FromAsciiConverter(java.lang.String fieldSpec)

Creates a new instance of FromAsciiConverter.

Parameters:

fieldSpec - ASCII field formatting spec

Method Detail

end

public void end(java.util.List nodes)

Ends the current traversal. Any post-processing on the post-traversal nodes should be done here, for example removing duplicate nodes. This method should also clean up any temporary states created during a traversal. After end(), the processor should be ready for the next new traversal.

Specified by:

end in interface org.writersforge.bellows.traverse.NodeProcessor

Overrides:

end in class BaseNodeProcessor

Parameters:

nodes - the list of nodes that has just been traversed

processNode

public java.util.List processNode(java.lang.Object node)

Process a single node. The processing action can be any arbitrary task, such as text replacement, data restructuring, or even statistical gathering. The processor should return a processed version of the node; this can be the same object untouched, or the same object modified, or a new set of objects.

Parameters:

node - the node to process

Returns:

a List of processing results (can be empty)

toString

public java.lang.String toString()

Convert this object to a String value.

Returns:

stringified object