com.marklogic.hub.flow

Interface Flow

All Known Implementing Classes:

FlowImpl

public interface Flow

Manages the creation and configuration of flow objects

Method Summary

Modifier and Type	Method and Description
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
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

Method Detail

setEntityName

void setEntityName(java.lang.String entityName)

Sets the entity name for the flow

Parameters:

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

getEntityName

java.lang.String getEntityName()

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

Returns:

entity name in string form

setName

void setName(java.lang.String name)

Sets the name of the flow

Parameters:

name - - string representing the name of the flow

getName

java.lang.String getName()

Gets the name of the flow

Returns:

the name of the flow in string form

setType

void setType(FlowType type)

Sets the type of the flow

Parameters:

type - - FlowType enum for harmonize or input

getType

FlowType getType()

Gets the FlowType enum for the flow

Returns:

FlowType of ingest or harmonize

setDataFormat

void setDataFormat(DataFormat dataFormat)

Sets the DataFormat for the flow

Parameters:

dataFormat - - DataFormat enum of json or xml

getDataFormat

DataFormat getDataFormat()

Returns the DataForm enum of the flow

Returns:

DataForm enum of json or xml

setCodeFormat

void setCodeFormat(CodeFormat codeFormat)

Sets the CodeFormat enum of the flow

Parameters:

codeFormat - enum of sjs or xqy

getCodeFormat

CodeFormat getCodeFormat()

Returns the CodeFormat enum of the flow

Returns:

CodeFormat enum of sjs or xqy

serialize

java.lang.String serialize()

Serializes the flow into an xml string

Returns:

a serialized xml string of the flow

toProperties

java.util.Properties toProperties()

Creates a properties object representing the flow

Returns:

a Properties object representation of the flow

getFlowDbPath

java.lang.String getFlowDbPath()

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

Returns:

a uri path as a string

getCollector

Collector getCollector()

Gets the collector to be used for the flow

Returns:

the collector object that is used for the flow

setCollector

void setCollector(Collector collector)

Sets the collector to be used for the flow

Parameters:

collector - the collector to be used for the flow

getMain

MainPlugin getMain()

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

Returns:

MainPlugin object

setMain

void setMain(MainPlugin main)

Sets the main plugin module for the flow

Parameters:

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