Module datarush.analytics

Package com.pervasive.datarush.analytics.pmml

Class PMMLPort

java.lang.Object

com.pervasive.datarush.ports.LogicalPort

com.pervasive.datarush.ports.model.AbstractModelPort<PMMLModel>

com.pervasive.datarush.analytics.pmml.PMMLPort

public final class PMMLPort
extends AbstractModelPort<PMMLModel>

Specialization of model ports for handling PMML models. Like model ports, the PMML model is duplicated to parallel downstream nodes when transmitted from a non-parallel node. (This would be a typical "predictor" scenario where a copy of a a model is used to predict in all data partitions). Similarly, when transmitted from parallel to non-parallel a gather is performed and thus a merge handler must be specified.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PMMLPort.Metadata	The port metadata associated with PMMLPorts.

Nested classes/interfaces inherited from class com.pervasive.datarush.ports.LogicalPort

LogicalPort.Direction

Field Summary

Fields

Modifier and Type	Field	Description
static AbstractModelPortFactory<PMMLModel,PMMLPort>	FACTORY	A factory for PMML ports.

Method Summary

Modifier and Type	Method	Description
AbstractModelPortFactory<PMMLModel,PMMLPort>	getFactory()	Returns the factory that knows how to create ports of this type
PMMLPort.Metadata	getMetadata(PMMLModel model)	Returns the metadata associate with the model.
Class<? extends PortMetadata>	getMetadataType()	Returns the class of metadata that this port uses
PMMLModelSpec	getPMMLModelSpec(MetadataContext ctx)	Getter to be used to set the PMMLModelSpec for a PMMLPort
void	setPMMLModelSpec(MetadataCalculationContext ctx, PMMLModelSpec spec)	Setter to be used to set the PMMLModelSpec for PMML ports.

Methods inherited from class com.pervasive.datarush.ports.model.AbstractModelPort

getModel, getModelClass, getStorageHandler, setMergeHandler, setModel

Methods inherited from class com.pervasive.datarush.ports.LogicalPort

getDirection, getName, getOwner, isOptional, toString

Methods inherited from class java.lang.Object

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

Field Detail

FACTORY

public static final AbstractModelPortFactory<PMMLModel,PMMLPort> FACTORY

A factory for PMML ports.

Method Detail

getFactory

public AbstractModelPortFactory<PMMLModel,PMMLPort> getFactory()

Description copied from class: LogicalPort

Returns the factory that knows how to create ports of this type

Specified by:

getFactory in class AbstractModelPort<PMMLModel>

Returns:

the factory that knows how to create ports of this type

setPMMLModelSpec

public void setPMMLModelSpec(MetadataCalculationContext ctx,
                             PMMLModelSpec spec)

Setter to be used to set the PMMLModelSpec for PMML ports.

Parameters:

ctx - the metadata context

spec - the PMMLModelSpec; may be null in which case we declare metadata to be dynamic

getPMMLModelSpec

public PMMLModelSpec getPMMLModelSpec(MetadataContext ctx)

Getter to be used to set the PMMLModelSpec for a PMMLPort

Parameters:

ctx - the metadata context

Returns:

the PMMLModelSpec

getMetadata

public PMMLPort.Metadata getMetadata(PMMLModel model)

Description copied from class: AbstractModelPort

Returns the metadata associate with the model. (Given a model, we should always be able to get its metadata.

Specified by:

getMetadata in class AbstractModelPort<PMMLModel>

Parameters:

model - the model object

Returns:

the metadata

getMetadataType

public Class<? extends PortMetadata> getMetadataType()

Description copied from class: LogicalPort

Returns the class of metadata that this port uses

Specified by:

getMetadataType in class LogicalPort

Returns:

the class of metadata that this port uses