com.marklogic.hub.flow.impl

Class FlowImpl

java.lang.Object

com.marklogic.hub.flow.impl.FlowImpl

All Implemented Interfaces:

Flow

public class FlowImpl
extends java.lang.Object
implements Flow

Constructor Summary

Constructors

Constructor and Description
FlowImpl()

Method Summary

Modifier and Type	Method and Description
static Flow	fromXml(org.w3c.dom.Node xml)
CodeFormat	getCodeFormat() Returns the CodeFormat enum of the flow
Collector	getCollector() Gets the collector to be used for the flow
DataFormat	getDataFormat() Returns the DataForm enum of the flow
java.lang.String	getEntityName() Returns the name of the entity that's been set for the flow in strong form
java.lang.String	getFlowDbPath() Gets the DbPath (uri) for the flow in string form
MainPlugin	getMain() Gets the main plugin module that the flow is set to use
java.lang.String	getName() Gets the name of the flow
FlowType	getType() Gets the FlowType enum for the flow
static Flow	loadFromFile(java.io.File file)
java.lang.String	serialize() Serializes the flow into an xml string
void	setCodeFormat(CodeFormat codeFormat) Sets the CodeFormat enum of the flow
void	setCollector(Collector collector) Sets the collector to be used for the flow
void	setDataFormat(DataFormat dataFormat) Sets the DataFormat for the flow
void	setEntityName(java.lang.String entityName) Sets the entity name for the flow
void	setMain(MainPlugin main) Sets the main plugin module for the flow
void	setName(java.lang.String name) Sets the name of the flow
void	setType(FlowType type) Sets the type of the flow
java.util.Properties	toProperties() Creates a properties object representing the flow

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowImpl

public FlowImpl()

Method Detail

setEntityName

public void setEntityName(java.lang.String entityName)

Description copied from interface: Flow

Sets the entity name for the flow

Specified by:

setEntityName in interface Flow

Parameters:

entityName - the string name of the entity to use in the flow

getEntityName

public java.lang.String getEntityName()

Description copied from interface: Flow

Returns the name of the entity that's been set for the flow in strong form

Specified by:

getEntityName in interface Flow

Returns:

entity name in string form

setName

public void setName(java.lang.String name)

Description copied from interface: Flow

Sets the name of the flow

Specified by:

setName in interface Flow

Parameters:

name - - string representing the name of the flow

getName

public java.lang.String getName()

Description copied from interface: Flow

Gets the name of the flow

Specified by:

getName in interface Flow

Returns:

the name of the flow in string form

setType

public void setType(FlowType type)

Description copied from interface: Flow

Sets the type of the flow

Specified by:

setType in interface Flow

Parameters:

type - - FlowType enum for harmonize or input

getType

public FlowType getType()

Description copied from interface: Flow

Gets the FlowType enum for the flow

Specified by:

getType in interface Flow

Returns:

FlowType of ingest or harmonize

setDataFormat

public void setDataFormat(DataFormat dataFormat)

Description copied from interface: Flow

Sets the DataFormat for the flow

Specified by:

setDataFormat in interface Flow

Parameters:

dataFormat - - DataFormat enum of json or xml

getDataFormat

public DataFormat getDataFormat()

Description copied from interface: Flow

Returns the DataForm enum of the flow

Specified by:

getDataFormat in interface Flow

Returns:

DataForm enum of json or xml

setCodeFormat

public void setCodeFormat(CodeFormat codeFormat)

Description copied from interface: Flow

Sets the CodeFormat enum of the flow

Specified by:

setCodeFormat in interface Flow

Parameters:

codeFormat - enum of sjs or xqy

getCodeFormat

public CodeFormat getCodeFormat()

Description copied from interface: Flow

Returns the CodeFormat enum of the flow

Specified by:

getCodeFormat in interface Flow

Returns:

CodeFormat enum of sjs or xqy

getCollector

public Collector getCollector()

Description copied from interface: Flow

Gets the collector to be used for the flow

Specified by:

getCollector in interface Flow

Returns:

the collector object that is used for the flow

setCollector

public void setCollector(Collector collector)

Description copied from interface: Flow

Sets the collector to be used for the flow

Specified by:

setCollector in interface Flow

Parameters:

collector - the collector to be used for the flow

getMain

public MainPlugin getMain()

Description copied from interface: Flow

Gets the main plugin module that the flow is set to use

Specified by:

getMain in interface Flow

Returns:

MainPlugin object

setMain

public void setMain(MainPlugin main)

Description copied from interface: Flow

Sets the main plugin module for the flow

Specified by:

setMain in interface Flow

Parameters:

main - - a MainPlugin object that defines the main plugin to be used

serialize

public java.lang.String serialize()

Description copied from interface: Flow

Serializes the flow into an xml string

Specified by:

serialize in interface Flow

Returns:

a serialized xml string of the flow

toProperties

public java.util.Properties toProperties()

Description copied from interface: Flow

Creates a properties object representing the flow

Specified by:

toProperties in interface Flow

Returns:

a Properties object representation of the flow

loadFromFile

public static Flow loadFromFile(java.io.File file)

fromXml

public static Flow fromXml(org.w3c.dom.Node xml)

getFlowDbPath

public java.lang.String getFlowDbPath()

Description copied from interface: Flow

Gets the DbPath (uri) for the flow in string form

Specified by:

getFlowDbPath in interface Flow

Returns:

a uri path as a string