Class DataInputPortConfig
- java.lang.Object
-
- com.tibco.ep.tcs.runtime.config.BaseConfig
-
- com.tibco.ep.tcs.runtime.config.BasePortConfig
-
- com.tibco.ep.tcs.runtime.config.DataInputOutputPortConfig
-
- com.tibco.ep.tcs.runtime.config.DataInputPortConfig
-
public final class DataInputPortConfig extends DataInputOutputPortConfig
A class describing a data input port. Enhances common input/output port configuration with an optional tuple schema. Constructs only from HOCON, since data input/output block configurations are only produced from HOCON.
-
-
Field Summary
-
Fields inherited from class com.tibco.ep.tcs.runtime.config.DataInputOutputPortConfig
UNSET_PORT_NUMBER
-
-
Constructor Summary
Constructors Constructor Description DataInputPortConfig()
Create a new empty port configuration.DataInputPortConfig(com.typesafe.config.Config config, TupleSchemaFactory tupleSchemaFactory, FlowValidationProblemList problems)
Create a new port from the specified HOCON configuration.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
fillMap(Map<String,Object> props)
Add this object's properties to the specified map.Schema
getTupleSchema()
This port's tuple schema, null if unknown.DataInputPortConfig
setDescription(String description)
Set this port's description, null if none.DataInputPortConfig
setName(String name)
Set this port's name.DataInputPortConfig
setPortNumber(int portNumber)
Set this port's number,DataInputOutputPortConfig.UNSET_PORT_NUMBER
if noneDataInputPortConfig
setRequired(boolean required)
Set true if the port is required, false otherwise.DataInputPortConfig
setTupleSchema(Schema tupleSchema)
Set this port's tuple schema, null if unknown.-
Methods inherited from class com.tibco.ep.tcs.runtime.config.DataInputOutputPortConfig
getName, getPortNumber
-
Methods inherited from class com.tibco.ep.tcs.runtime.config.BasePortConfig
getDescription, isRequired
-
Methods inherited from class com.tibco.ep.tcs.runtime.config.BaseConfig
toHOCON
-
-
-
-
Constructor Detail
-
DataInputPortConfig
public DataInputPortConfig()
Create a new empty port configuration.
-
DataInputPortConfig
public DataInputPortConfig(com.typesafe.config.Config config, TupleSchemaFactory tupleSchemaFactory, FlowValidationProblemList problems)
Create a new port from the specified HOCON configuration.
- Parameters:
config
- source HOCON configurationtupleSchemaFactory
- tuple schema factory, used to create EventFlow tuple schemas from HOCON in the supplied configurationproblems
- any validation problems encountered while creating an input port EventFlow tuple schema are added to this list
-
-
Method Detail
-
getTupleSchema
public Schema getTupleSchema()
This port's tuple schema, null if unknown. Input ports can provide them so that flow graph generation can see the schema and perform default transforms if possible.
- Returns:
- tuple schema, null if unknown
-
setTupleSchema
public DataInputPortConfig setTupleSchema(Schema tupleSchema)
Set this port's tuple schema, null if unknown. Input ports can provide them so that flow graph generation can see the schema and perform default transforms if possible.
- Parameters:
tupleSchema
- tuple schema, null if unknown- Returns:
- this object
-
setName
public DataInputPortConfig setName(String name)
Set this port's name.
- Overrides:
setName
in classDataInputOutputPortConfig
- Parameters:
name
- port name- Returns:
- this object
-
setPortNumber
public DataInputPortConfig setPortNumber(int portNumber)
Set this port's number,
DataInputOutputPortConfig.UNSET_PORT_NUMBER
if none- Overrides:
setPortNumber
in classDataInputOutputPortConfig
- Parameters:
portNumber
- port number- Returns:
- this object
-
setRequired
public DataInputPortConfig setRequired(boolean required)
Set true if the port is required, false otherwise.
- Overrides:
setRequired
in classDataInputOutputPortConfig
- Parameters:
required
- true if required, false otherwise- Returns:
- this object
-
setDescription
public DataInputPortConfig setDescription(String description)
Set this port's description, null if none.
- Overrides:
setDescription
in classDataInputOutputPortConfig
- Parameters:
description
- description, null if none- Returns:
- this object
-
fillMap
protected void fillMap(Map<String,Object> props)
Add this object's properties to the specified map.
- Overrides:
fillMap
in classDataInputOutputPortConfig
- Parameters:
props
- map to fill
-
-