Humboldt Alignment Editor 2.5.0

eu.esdihumboldt.hale.common.align.transformation.function
Interface PropertyTransformation<E extends TransformationEngine>

Type Parameters:
E - the transformation engine type
All Superinterfaces:
TransformationFunction<E>
All Known Implementing Classes:
AbstractPropertyTransformation, AbstractSingleTargetPropertyTransformation, Assign, CalculateArea, CalculateLength, Centroid, ClassificationMapping, DateExtraction, FormattedString, GeographicalName, GroovyTransformation, Identifier, MathematicalExpression, NetworkExpansion, OrdinatesToPoint, Rename, SequentialID

public interface PropertyTransformation<E extends TransformationEngine>
extends TransformationFunction<E>

Function that is evaluated based on variables populated by property values.

Author:
Simon Templer

Method Summary
 boolean allowAutomatedResultConversion()
          Specifies if the automatic conversion of the execution results according to the corresponding property definitions is allowed and therefore should be performed by the PropertyTransformer.
 com.google.common.collect.ListMultimap<String,Object> getResults()
          Get the TransformationFunction.execute(String, TransformationEngine, Map, TransformationLog)ion results.
 void setExpectedResult(com.google.common.collect.ListMultimap<String,PropertyEntityDefinition> resultNames)
          Set the expected result names.
 void setTargetType(TypeDefinition targetType)
          Set the target type of the created instance that is to be populated with the function result.
 void setVariables(com.google.common.collect.ListMultimap<String,PropertyValue> variables)
          Set the property values serving as variables for the function.
 
Methods inherited from interface eu.esdihumboldt.hale.common.align.transformation.function.TransformationFunction
execute, setExecutionContext, setParameters
 

Method Detail

setVariables

void setVariables(com.google.common.collect.ListMultimap<String,PropertyValue> variables)
Set the property values serving as variables for the function.

Parameters:
variables - the property values, variable names are mapped to property values

setTargetType

void setTargetType(TypeDefinition targetType)
Set the target type of the created instance that is to be populated with the function result.

Parameters:
targetType - the type of the target instance

setExpectedResult

void setExpectedResult(com.google.common.collect.ListMultimap<String,PropertyEntityDefinition> resultNames)
Set the expected result names.

Parameters:
resultNames - the names of the expected results associated with the corresponding entity definition

getResults

com.google.common.collect.ListMultimap<String,Object> getResults()
Get the TransformationFunction.execute(String, TransformationEngine, Map, TransformationLog)ion results.

Returns:
the execution results, result names are mapped to result values
See Also:
setExpectedResult(ListMultimap)

allowAutomatedResultConversion

boolean allowAutomatedResultConversion()
Specifies if the automatic conversion of the execution results according to the corresponding property definitions is allowed and therefore should be performed by the PropertyTransformer.

Returns:
if automated conversion of the result values is allowed

Humboldt Alignment Editor 2.5.0

Build 2012-12-03_12-30-59
Revision 9d2dd4b0318cda9f1393b1ddd390f7f792d70a2d