weka.knowledgeflow

Class JSONFlowUtils

java.lang.Object

weka.knowledgeflow.JSONFlowUtils

public class JSONFlowUtils
extends java.lang.Object

Utilities for building and saving flows from JSON data

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS
static java.lang.String	CONNECTIONS
static java.lang.String	COORDINATES
static java.lang.String	ENUM_HELPER
static java.lang.String	FLOW_NAME
static java.lang.String	LOADER
static java.lang.String	OPTIONHANDLER
static java.lang.String	OPTIONS
static java.lang.String	PROPERTIES
static java.lang.String	SAVER
static java.lang.String	STEPS

Constructor Summary

Constructors

Constructor and Description
JSONFlowUtils()

Method Summary

Modifier and Type	Method and Description
protected static void	addEnum(java.lang.String propName, java.lang.Enum ee, JSONNode json) Add an enum to the JSON
protected static void	addLoader(java.lang.String propName, Loader loader, JSONNode json) Add a weka.core.converters.Loader to the JSON
protected static void	addNameValue(java.lang.StringBuilder b, java.lang.String name, java.lang.String value, boolean comma) Add a name,value pair to the JSON
protected static void	addOptionHandler(java.lang.String propName, OptionHandler handler, JSONNode json) Add an OptionHandler spec to the JSON
protected static void	addSaver(java.lang.String propName, Saver saver, JSONNode json) Add a weka.core.converters.Saver to the JSON
protected static void	addStepJSONtoFlowArray(JSONNode stepArray, StepManagerImpl stepManager) Add a step to the JSON
protected static java.io.File	checkForFileProp(java.lang.Object theValue, java.beans.PropertyDescriptor propD) Checks a property to see if it is tagged with the FilePropertyMetadata class.
static java.lang.String	flowToJSON(Flow flow) Utility routine to serialize a supplied flow to a JSON string
static Flow	JSONToFlow(java.lang.String flowJSON, boolean dontComplainAboutMissingConnections) Utility routine to deserialize a flow from the supplied JSON string
static void	main(java.lang.String[] args) Main method for testing this class
protected static void	readConnectionsForStep(JSONNode step, Flow flow) Read step connections from the supplied JSON node
protected static void	readConnectionsForStep(JSONNode step, Flow flow, boolean dontComplainAboutMissingConnections) Read step connections from the supplied JSON node
static Flow	readFlow(java.io.File file) Read a flow from the supplied file
static Flow	readFlow(java.io.File file, boolean dontComplainAboutMissingConnections) Read a flow from the supplied file
static Flow	readFlow(java.io.InputStream is) Read a Flow from the supplied input stream
static Flow	readFlow(java.io.InputStream is, boolean dontComplainAboutMissingConnections) Read a Flow from the supplied input stream
static Flow	readFlow(java.io.Reader sr) Read a flow from the supplied reader
static Flow	readFlow(java.io.Reader sr, boolean dontComplainAboutMissingConnections) Read a flow from the supplied reader
protected static void	readStep(JSONNode stepNode, Flow flow) Read a Step from the supplied JSON node
protected static java.lang.Object	readStepObjectProperty(JSONNode propNode) Read a step property object from the current JSON node.
protected static java.lang.Object	readStepPropertyEnum(JSONNode enumNode) Read an enum from the current JSON node
protected static Loader	readStepPropertyLoader(JSONNode loaderNode) Read a weka.core.converters.Loader from the current JSON node
protected static OptionHandler	readStepPropertyOptionHandler(JSONNode optionHNode) Read an OptionHandler from the current JSON node
protected static Saver	readStepPropertySaver(JSONNode saverNode) Read a weka.core.converters.Saver from the current JSON node
static void	writeFlow(Flow flow, java.io.File file) Serializes the supplied flow to JSON and writes it out to the supplied file
static void	writeFlow(Flow flow, java.io.OutputStream os) Serializes the supplied flow to JSON and writes out using the supplied output stream
static void	writeFlow(Flow flow, java.io.Writer writer) Serializes the supplied flow to JSON and writes out using the supplied writer

Methods inherited from class java.lang.Object

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

Field Detail

FLOW_NAME

public static final java.lang.String FLOW_NAME

See Also:

Constant Field Values

STEPS

public static final java.lang.String STEPS

See Also:

Constant Field Values

OPTIONHANDLER

public static final java.lang.String OPTIONHANDLER

See Also:

Constant Field Values

OPTIONS

public static final java.lang.String OPTIONS

See Also:

Constant Field Values

LOADER

public static final java.lang.String LOADER

See Also:

Constant Field Values

SAVER

public static final java.lang.String SAVER

See Also:

Constant Field Values

ENUM_HELPER

public static final java.lang.String ENUM_HELPER

See Also:

Constant Field Values

CLASS

public static final java.lang.String CLASS

See Also:

Constant Field Values

PROPERTIES

public static final java.lang.String PROPERTIES

See Also:

Constant Field Values

CONNECTIONS

public static final java.lang.String CONNECTIONS

See Also:

Constant Field Values

COORDINATES

public static final java.lang.String COORDINATES

See Also:

Constant Field Values

Constructor Detail

JSONFlowUtils

public JSONFlowUtils()

Method Detail

addNameValue

protected static void addNameValue(java.lang.StringBuilder b,
                                   java.lang.String name,
                                   java.lang.String value,
                                   boolean comma)

Add a name,value pair to the JSON

Parameters:

b - the StringBuilder to add the pair to

name - the name

value - the associated value

comma - if true postfix a comma

addOptionHandler

protected static void addOptionHandler(java.lang.String propName,
                                       OptionHandler handler,
                                       JSONNode json)

Add an OptionHandler spec to the JSON

Parameters:

propName - the name to associate with the option handler

handler - the option handler

json - the current to add to

addEnum

protected static void addEnum(java.lang.String propName,
                              java.lang.Enum ee,
                              JSONNode json)

Add an enum to the JSON

Parameters:

propName - the name to associate the enum with

ee - the enum to add

json - the current JSONNode to add to

addSaver

protected static void addSaver(java.lang.String propName,
                               Saver saver,
                               JSONNode json)

Add a weka.core.converters.Saver to the JSON

Parameters:

propName - the name to associate the saver with

saver - the saver to add

json - the current JSONNode to add to

addLoader

protected static void addLoader(java.lang.String propName,
                                Loader loader,
                                JSONNode json)

Add a weka.core.converters.Loader to the JSON

Parameters:

propName - the name to associate the loader with

loader - the loader to add

json - the curren JSONNode to add to

addStepJSONtoFlowArray

protected static void addStepJSONtoFlowArray(JSONNode stepArray,
                                             StepManagerImpl stepManager)
                                      throws WekaException

Add a step to the JSON

Parameters:

stepArray - the JSONNode to add the step to

stepManager - the StepManager of the step to add

Throws:

WekaException - if a problem occurs

readStepPropertyLoader

protected static Loader readStepPropertyLoader(JSONNode loaderNode)
                                        throws WekaException

Read a weka.core.converters.Loader from the current JSON node

Parameters:

loaderNode - the JSONNode to read the loader from

Returns:

the instantiated loader

Throws:

WekaException - if a problem occurs

readStepPropertySaver

protected static Saver readStepPropertySaver(JSONNode saverNode)
                                      throws WekaException

Read a weka.core.converters.Saver from the current JSON node

Parameters:

saverNode - the JSONNode to read from

Returns:

an instantiated saver

Throws:

WekaException - if a problem occurs

readStepPropertyOptionHandler

protected static OptionHandler readStepPropertyOptionHandler(JSONNode optionHNode)
                                                      throws WekaException

Read an OptionHandler from the current JSON node

Parameters:

optionHNode - the JSONNode to read from

Returns:

an instantiated and configured option handler

Throws:

WekaException - if a problem occurs

readStepPropertyEnum

protected static java.lang.Object readStepPropertyEnum(JSONNode enumNode)
                                                throws WekaException

Read an enum from the current JSON node

Parameters:

enumNode - the JSONNode to read from

Returns:

the enum object

Throws:

WekaException - if a problem occurs

readStepObjectProperty

protected static java.lang.Object readStepObjectProperty(JSONNode propNode)
                                                  throws java.lang.Exception

Read a step property object from the current JSON node. Handles option handlers, loaders, savers and enums.

Parameters:

propNode - the JSONNode to read from

Returns:

a step property object

Throws:

java.lang.Exception - if a problem occurs

checkForFileProp

protected static java.io.File checkForFileProp(java.lang.Object theValue,
                                               java.beans.PropertyDescriptor propD)

Checks a property to see if it is tagged with the FilePropertyMetadata class. If so, it converts the string property into an actual file property so that the Step can be restored correctly

Parameters:

theValue - the value of the property

propD - the PropertyDescriptor for the property

Returns:

a File object or null if this property is not tagged as a file property

readStep

protected static void readStep(JSONNode stepNode,
                               Flow flow)
                        throws WekaException

Read a Step from the supplied JSON node

Parameters:

stepNode - the JSONNode to read from

flow - the Flow to add the read step to

Throws:

WekaException - if a problem occurs

readConnectionsForStep

protected static void readConnectionsForStep(JSONNode step,
                                             Flow flow)
                                      throws WekaException

Read step connections from the supplied JSON node

Parameters:

step - the JSONNode to read from

flow - the flow being constructed

Throws:

WekaException - if a problem occurs

readConnectionsForStep

protected static void readConnectionsForStep(JSONNode step,
                                             Flow flow,
                                             boolean dontComplainAboutMissingConnections)
                                      throws WekaException

Read step connections from the supplied JSON node

Parameters:

step - the JSONNode to read from

flow - the flow being constructed

dontComplainAboutMissingConnections - true if no exception should be raised if the step named in a connection is not present in the flow

Throws:

WekaException - if a problem occurs

writeFlow

public static void writeFlow(Flow flow,
                             java.io.Writer writer)
                      throws WekaException

Serializes the supplied flow to JSON and writes out using the supplied writer

Parameters:

flow - the Flow to serialize

writer - the Writer to write to

Throws:

WekaException - if a problem occurs

writeFlow

public static void writeFlow(Flow flow,
                             java.io.OutputStream os)
                      throws WekaException

Serializes the supplied flow to JSON and writes out using the supplied output stream

Parameters:

flow - the Flow to serialize

os - the OutputStream to write to

Throws:

WekaException - if a problem occurs

writeFlow

public static void writeFlow(Flow flow,
                             java.io.File file)
                      throws WekaException

Serializes the supplied flow to JSON and writes it out to the supplied file

Parameters:

flow - the Flow to serialize

file - the File to write to

Throws:

WekaException - if a problem occurs

readFlow

public static Flow readFlow(java.io.File file)
                     throws WekaException

Read a flow from the supplied file

Parameters:

file - the file to read from

Returns:

the deserialized Flow

Throws:

WekaException - if a problem occurs

readFlow

public static Flow readFlow(java.io.File file,
                            boolean dontComplainAboutMissingConnections)
                     throws WekaException

Read a flow from the supplied file

Parameters:

file - the file to read from

dontComplainAboutMissingConnections - true if no exceptions should be raised if connections are missing in the flow

Returns:

the deserialized Flow

Throws:

WekaException - if a problem occurs

readFlow

public static Flow readFlow(java.io.InputStream is)
                     throws WekaException

Read a Flow from the supplied input stream

Parameters:

is - the InputStream to read from

Returns:

the deserialized flow

Throws:

WekaException - if a problem occurs

readFlow

public static Flow readFlow(java.io.InputStream is,
                            boolean dontComplainAboutMissingConnections)
                     throws WekaException

Read a Flow from the supplied input stream

Parameters:

is - the InputStream to read from

dontComplainAboutMissingConnections - true if no exception should be raised if there are missing connections

Returns:

the deserialized flow

Throws:

WekaException - if a problem occurs

readFlow

public static Flow readFlow(java.io.Reader sr)
                     throws WekaException

Read a flow from the supplied reader

Parameters:

sr - the reader to read from

Returns:

the deserialized flow

Throws:

WekaException - if a problem occurs

readFlow

public static Flow readFlow(java.io.Reader sr,
                            boolean dontComplainAboutMissingConnections)
                     throws WekaException

Read a flow from the supplied reader

Parameters:

sr - the reader to read from

dontComplainAboutMissingConnections - true if no exception should be raised if there are missing connections

Returns:

the deserialized flow

Throws:

WekaException - if a problem occurs

JSONToFlow

public static Flow JSONToFlow(java.lang.String flowJSON,
                              boolean dontComplainAboutMissingConnections)
                       throws WekaException

Utility routine to deserialize a flow from the supplied JSON string

Parameters:

flowJSON - the string containing a flow in JSON form

dontComplainAboutMissingConnections - to not raise any exceptions if there are missing connections in the flow

Returns:

the deserialized flow

Throws:

WekaException - if a problem occurs

flowToJSON

public static java.lang.String flowToJSON(Flow flow)
                                   throws WekaException

Utility routine to serialize a supplied flow to a JSON string

Parameters:

flow - the flow to serialize

Returns:

a string containing the flow in JSON form

Throws:

WekaException - if a problem occurs

main

public static void main(java.lang.String[] args)

Main method for testing this class

Parameters:

args - command line arguments