com.rapidminer.operator.ports.metadata
Class ExampleSetPrecondition

java.lang.Object
  com.rapidminer.operator.ports.metadata.AbstractPrecondition
      com.rapidminer.operator.ports.metadata.ExampleSetPrecondition

All Implemented Interfaces:

Precondition

Direct Known Subclasses:

CapabilityPrecondition, ExampleSetContainsSeriesPrecondition

public class ExampleSetPrecondition
extends AbstractPrecondition

Author:

Simon Fischer

Constructor Summary

ExampleSetPrecondition(InputPort inputPort)

ExampleSetPrecondition(InputPort inputPort, int allowedValueTypesForRegularAttributes, java.lang.String... requiredSpecials)

ExampleSetPrecondition(InputPort inputPort, java.lang.String[] requiredAttributeNames, int allowedValueTypesForRegular, java.lang.String... requiredSpecials)

ExampleSetPrecondition(InputPort inputPort, java.lang.String[] requiredAttributeNames, int allowedValueTypesForRegular, java.lang.String[] ignoreForTypeCheck, int allowedValueTypesForSpecial, java.lang.String... requiredSpecials)

ExampleSetPrecondition(InputPort inputPort, java.lang.String requiredSpecials, int allowedValueTypForSpecial)

Method Summary

void	assumeSatisfied() Assume that the precondition is satisfied, i.e., artificially generate compatible meta data at the input port.
void	check(MetaData metaData) Checks whether the precondition is satisfied, registering a MetaDataError with the input port if not.
java.lang.String	getDescription() Returns a human readable description.
MetaData	getExpectedMetaData() Returns the meta data required by this precondition.
boolean	isCompatible(MetaData input, CompatibilityLevel level) Returns true if the given object is compatible with this precondition.
void	makeAdditionalChecks(ExampleSetMetaData emd) Can be implemented by subclasses.
void	setOptional(boolean optional)

Methods inherited from class com.rapidminer.operator.ports.metadata.AbstractPrecondition

createError, createError, getInputPort, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ExampleSetPrecondition

public ExampleSetPrecondition(InputPort inputPort)

ExampleSetPrecondition

public ExampleSetPrecondition(InputPort inputPort,
                              int allowedValueTypesForRegularAttributes,
                              java.lang.String... requiredSpecials)

ExampleSetPrecondition

public ExampleSetPrecondition(InputPort inputPort,
                              java.lang.String[] requiredAttributeNames,
                              int allowedValueTypesForRegular,
                              java.lang.String... requiredSpecials)

ExampleSetPrecondition

public ExampleSetPrecondition(InputPort inputPort,
                              java.lang.String requiredSpecials,
                              int allowedValueTypForSpecial)

ExampleSetPrecondition

public ExampleSetPrecondition(InputPort inputPort,
                              java.lang.String[] requiredAttributeNames,
                              int allowedValueTypesForRegular,
                              java.lang.String[] ignoreForTypeCheck,
                              int allowedValueTypesForSpecial,
                              java.lang.String... requiredSpecials)

Method Detail

setOptional

public void setOptional(boolean optional)

assumeSatisfied

public void assumeSatisfied()

Description copied from interface: Precondition

Assume that the precondition is satisfied, i.e., artificially generate compatible meta data at the input port. This method is used to check what output would be generated if the input was correctly delivered.

check

public void check(MetaData metaData)

Description copied from interface: Precondition

Checks whether the precondition is satisfied, registering a MetaDataError with the input port if not.

Parameters:

metaData - the delivered meta data. Note that this may differ from the meta data currently assigned to the input port for which this Precondition was created, e.g. for a ClooectionPrecondition.

makeAdditionalChecks

public void makeAdditionalChecks(ExampleSetMetaData emd)
                          throws UndefinedParameterError

Can be implemented by subclasses.

Throws:

UndefinedParameterError

getDescription

public java.lang.String getDescription()

Description copied from interface: Precondition

Returns a human readable description.

isCompatible

public boolean isCompatible(MetaData input,
                            CompatibilityLevel level)

Description copied from interface: Precondition

Returns true if the given object is compatible with this precondition.

getExpectedMetaData

public MetaData getExpectedMetaData()

Description copied from interface: Precondition

Returns the meta data required by this precondition.