Humboldt Alignment Editor 2.5.0

eu.esdihumboldt.hale.common.align.transformation.function.impl
Class AbstractSingleTargetPropertyTransformation<E extends TransformationEngine>

java.lang.Object
  extended by eu.esdihumboldt.hale.common.align.transformation.function.impl.AbstractTransformationFunction<E>
      extended by eu.esdihumboldt.hale.common.align.transformation.function.impl.AbstractPropertyTransformation<E>
          extended by eu.esdihumboldt.hale.common.align.transformation.function.impl.AbstractSingleTargetPropertyTransformation<E>
Type Parameters:
E - the transformation engine type
All Implemented Interfaces:
PropertyTransformation<E>, TransformationFunction<E>
Direct Known Subclasses:
Assign, CalculateArea, CalculateLength, Centroid, ClassificationMapping, DateExtraction, FormattedString, GeographicalName, GroovyTransformation, Identifier, MathematicalExpression, NetworkExpansion, OrdinatesToPoint, Rename, SequentialID

public abstract class AbstractSingleTargetPropertyTransformation<E extends TransformationEngine>
extends AbstractPropertyTransformation<E>

Abstract property transformation implementation for functions with a single target property.

Author:
Simon Templer

Constructor Summary
AbstractSingleTargetPropertyTransformation()
           
 
Method Summary
protected  com.google.common.collect.ListMultimap<String,Object> evaluate(String transformationIdentifier, E engine, com.google.common.collect.ListMultimap<String,PropertyValue> variables, com.google.common.collect.ListMultimap<String,PropertyEntityDefinition> resultNames, Map<String,String> executionParameters, TransformationLog log)
          Execute the evaluation function as configured.
protected abstract  Object evaluate(String transformationIdentifier, E engine, com.google.common.collect.ListMultimap<String,PropertyValue> variables, String resultName, PropertyEntityDefinition resultProperty, Map<String,String> executionParameters, TransformationLog log)
          Execute the evaluation function as configured.
 
Methods inherited from class eu.esdihumboldt.hale.common.align.transformation.function.impl.AbstractPropertyTransformation
allowAutomatedResultConversion, execute, getResults, getTargetType, setExpectedResult, setTargetType, setVariables
 
Methods inherited from class eu.esdihumboldt.hale.common.align.transformation.function.impl.AbstractTransformationFunction
checkParameter, getExecutionContext, getOptionalParameter, getParameterChecked, getParameters, setExecutionContext, setParameters
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface eu.esdihumboldt.hale.common.align.transformation.function.TransformationFunction
setExecutionContext, setParameters
 

Constructor Detail

AbstractSingleTargetPropertyTransformation

public AbstractSingleTargetPropertyTransformation()
Method Detail

evaluate

protected com.google.common.collect.ListMultimap<String,Object> evaluate(String transformationIdentifier,
                                                                         E engine,
                                                                         com.google.common.collect.ListMultimap<String,PropertyValue> variables,
                                                                         com.google.common.collect.ListMultimap<String,PropertyEntityDefinition> resultNames,
                                                                         Map<String,String> executionParameters,
                                                                         TransformationLog log)
                                                                  throws TransformationException
Description copied from class: AbstractPropertyTransformation
Execute the evaluation function as configured.

Specified by:
evaluate in class AbstractPropertyTransformation<E extends TransformationEngine>
Parameters:
transformationIdentifier - the transformation function identifier
engine - the transformation engine that may be used for the function execution
variables - the input variables
resultNames - the expected results (names associated with the corresponding entity definitions)
executionParameters - additional parameters for the execution, may be null
log - the transformation log to report any information about the execution of the transformation to
Returns:
the evaluation result
Throws:
TransformationException - if an unrecoverable error occurs during transformation
See Also:
AbstractPropertyTransformation.evaluate(String, TransformationEngine, ListMultimap, ListMultimap, Map, TransformationLog)

evaluate

protected abstract Object evaluate(String transformationIdentifier,
                                   E engine,
                                   com.google.common.collect.ListMultimap<String,PropertyValue> variables,
                                   String resultName,
                                   PropertyEntityDefinition resultProperty,
                                   Map<String,String> executionParameters,
                                   TransformationLog log)
                            throws TransformationException,
                                   NoResultException
Execute the evaluation function as configured.

Parameters:
transformationIdentifier - the transformation function identifier
engine - the transformation engine that may be used for the function execution
variables - the input variables
resultName - the name of the result
resultProperty - the property entity definition associated with the result
executionParameters - additional parameters for the execution, may be null
log - the transformation log to report any information about the execution of the transformation to
Returns:
the evaluation result
Throws:
TransformationException - if an unrecoverable error occurs during transformation
NoResultException - if the function does not yield a result

Humboldt Alignment Editor 2.5.0

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