Package eu.europa.ted.efx.xpath

Class XPathScriptGenerator

java.lang.Object

eu.europa.ted.efx.xpath.XPathScriptGenerator

All Implemented Interfaces:

ScriptGenerator

public class XPathScriptGenerator
extends Object
implements ScriptGenerator

Constructor Summary

Constructors

Constructor	Description
XPathScriptGenerator()

Method Summary

Modifier and Type	Method	Description
Expression.DateExpression	composeAddition(Expression.DateExpression date, Expression.DurationExpression duration)
Expression.DurationExpression	composeAddition(Expression.DurationExpression left, Expression.DurationExpression right)
<T extends Expression> Expression.BooleanExpression	composeAllSatisfy(Expression.ListExpression<T> list, String variableName, Expression.BooleanExpression booleanExpression)
<T extends Expression> Expression.BooleanExpression	composeAnySatisfies(Expression.ListExpression<T> list, String variableName, Expression.BooleanExpression booleanExpression)
Expression.BooleanExpression	composeComparisonOperation(Expression leftOperand, String operator, Expression rightOperand)	Returns the target language script that compares the two operands (for equality etc.).
<T extends Expression> T	composeConditionalExpression(Expression.BooleanExpression condition, T whenTrue, T whenFalse, Class<T> type)
Expression.BooleanExpression	composeContainsCondition(Expression.StringExpression haystack, Expression.StringExpression needle)	Boolean functions
<T extends Expression,L extends Expression.ListExpression<T>> Expression.BooleanExpression	composeContainsCondition(T needle, L haystack)	Returns the target language script that checks whether a given list of values (haystack) contains a given value (needle).
Expression.NumericExpression	composeCountOperation(Expression.ListExpressionBase list)
Expression.NumericExpression	composeCountOperation(Expression.PathExpression nodeSet)	Numeric functions
Expression.BooleanExpression	composeEndsWithCondition(Expression.StringExpression text, Expression.StringExpression endsWith)
Expression.BooleanExpression	composeExistsCondition(Expression.PathExpression reference)
Expression.PathExpression	composeExternalReference(Expression.StringExpression externalReference)	TODO: Not properly defined yet.
<T extends Expression> T	composeFieldAttributeReference(Expression.PathExpression fieldReference, String attribute, Class<T> type)	Given a PathExpression and an attribute name, this method should return the target language script for retrieving the value of the attribute.
Expression.PathExpression	composeFieldInExternalReference(Expression.PathExpression externalReference, Expression.PathExpression fieldReference)	TODO: Not properly defined yet.
<T extends Expression> T	composeFieldReferenceWithPredicate(Expression.PathExpression fieldReference, Expression.BooleanExpression predicate, Class<T> type)	Given a PathExpression and a predicate, this method should return the target language script for matching the subset of nodes in the PathExpression that match the predicate.
<T extends Expression> T	composeFieldValueReference(Expression.PathExpression fieldReference, Class<T> type)	Given a PathExpression, this method should return the target language script for retrieving the value of the field.
<T1 extends Expression,L1 extends Expression.ListExpression<T1>,T2 extends Expression,L2 extends Expression.ListExpression<T2>> L2	composeForExpression(String variableName, L1 sourceList, T2 expression, Class<L2> targetListType)
<T extends Expression,L extends Expression.ListExpression<T>> L	composeList(List<T> list, Class<L> type)	Takes a list of string expressions and returns the target language script that corresponds to a list of string expressions.
Expression.BooleanExpression	composeLogicalAnd(Expression.BooleanExpression leftOperand, Expression.BooleanExpression rightOperand)	BooleanExpressions
Expression.BooleanExpression	composeLogicalNot(Expression.BooleanExpression condition)	Returns the target language script for performing a logical NOT operation on the given boolean expression.
Expression.BooleanExpression	composeLogicalOr(Expression.BooleanExpression leftOperand, Expression.BooleanExpression rightOperand)	Returns the target language script for performing a logical OR operation on the two given operands.
Expression.DurationExpression	composeMultiplication(Expression.NumericExpression number, Expression.DurationExpression duration)
<T extends Expression> T	composeNodeReferenceWithPredicate(Expression.PathExpression nodeReference, Expression.BooleanExpression predicate, Class<T> type)	Given a PathExpression and a predicate, this method should return the target language script for matching the subset of nodes in the PathExpression that match the predicate.
Expression.StringExpression	composeNumberFormatting(Expression.NumericExpression number, Expression.StringExpression format)
Expression.NumericExpression	composeNumericOperation(Expression.NumericExpression leftOperand, String operator, Expression.NumericExpression rightOperand)	Given a numeric operation, this method should return the target language script that performs the operation.
<T extends Expression> T	composeParenthesizedExpression(T expression, Class<T> type)	Returns the given expression parenthesized in the target language.
Expression.BooleanExpression	composePatternMatchCondition(Expression.StringExpression expression, String pattern)	Returns the target language script that checks whether a given string matches the given RegEx pattern.
Expression.BooleanExpression	composeStartsWithCondition(Expression.StringExpression text, Expression.StringExpression startsWith)
Expression.StringExpression	composeStringConcatenation(List<Expression.StringExpression> list)
Expression.NumericExpression	composeStringLengthCalculation(Expression.StringExpression text)
Expression.StringExpression	composeSubstringExtraction(Expression.StringExpression text, Expression.NumericExpression start)
Expression.StringExpression	composeSubstringExtraction(Expression.StringExpression text, Expression.NumericExpression start, Expression.NumericExpression length)	String functions
Expression.DurationExpression	composeSubtraction(Expression.DateExpression startDate, Expression.DateExpression endDate)
Expression.DateExpression	composeSubtraction(Expression.DateExpression date, Expression.DurationExpression duration)
Expression.DurationExpression	composeSubtraction(Expression.DurationExpression left, Expression.DurationExpression right)
Expression.NumericExpression	composeSumOperation(Expression.NumericListExpression nodeSet)
Expression.NumericExpression	composeSumOperation(Expression.PathExpression nodeSet)
Expression.DateExpression	composeToDateConversion(Expression.StringExpression date)	Date functions
Expression.DurationExpression	composeToDayTimeDurationConversion(Expression.StringExpression text)	Duration functions
Expression.NumericExpression	composeToNumberConversion(Expression.StringExpression text)
Expression.StringExpression	composeToStringConversion(Expression.NumericExpression number)
Expression.TimeExpression	composeToTimeConversion(Expression.StringExpression time)	Time functions
Expression.DurationExpression	composeToYearMonthDurationConversion(Expression.StringExpression text)
<T extends Expression> T	composeVariableReference(String variableName, Class<T> type)	Given a variable name this method should return script to dereference the variable.
Expression.BooleanExpression	getBooleanEquivalent(boolean value)	Takes a Java Boolean value and returns the corresponding target language script.
Expression.DateExpression	getDateLiteralEquivalent(String literal)
Expression.DurationExpression	getDurationLiteralEquivalent(String literal)
Expression.NumericExpression	getNumericLiteralEquivalent(String literal)	Returns the numeric literal passed in target language script.
Expression.StringExpression	getStringLiteralEquivalent(String literal)	Returns the string literal in the target language.
Expression.StringExpression	getStringLiteralFromUnquotedString(String value)	Gets a piece of text and returns it inside quotes as expected by the target language.
Expression.TimeExpression	getTimeLiteralEquivalent(String literal)
Expression.PathExpression	joinPaths(Expression.PathExpression first, Expression.PathExpression second)	Joins two given path expressions into one by placing the second after the first and using the proper delimiter.

Methods inherited from class java.lang.Object

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

Constructor Detail

XPathScriptGenerator

public XPathScriptGenerator()

Method Detail

composeNodeReferenceWithPredicate

public <T extends Expression> T composeNodeReferenceWithPredicate(Expression.PathExpression nodeReference,
                                                                  Expression.BooleanExpression predicate,
                                                                  Class<T> type)

Description copied from interface: ScriptGenerator

Given a PathExpression and a predicate, this method should return the target language script for matching the subset of nodes in the PathExpression that match the predicate. Similar to ScriptGenerator.composeFieldReferenceWithPredicate(eu.europa.ted.efx.model.Expression.PathExpression, eu.europa.ted.efx.model.Expression.BooleanExpression, java.lang.Class<T>) but for nodes. Quick reminder: the difference between fields and nodes is that fields contain values, while nodes contain other nodes and/or fields.

Specified by:

composeNodeReferenceWithPredicate in interface ScriptGenerator

composeFieldReferenceWithPredicate

public <T extends Expression> T composeFieldReferenceWithPredicate(Expression.PathExpression fieldReference,
                                                                   Expression.BooleanExpression predicate,
                                                                   Class<T> type)

Description copied from interface: ScriptGenerator

Given a PathExpression and a predicate, this method should return the target language script for matching the subset of nodes in the PathExpression that match the predicate. Similar to ScriptGenerator.composeNodeReferenceWithPredicate(eu.europa.ted.efx.model.Expression.PathExpression, eu.europa.ted.efx.model.Expression.BooleanExpression, java.lang.Class<T>) but for fields. Quick reminder: the difference between fields and nodes is that fields contain values, while nodes contain other nodes and/or fields.

Specified by:

composeFieldReferenceWithPredicate in interface ScriptGenerator

composeFieldValueReference

public <T extends Expression> T composeFieldValueReference(Expression.PathExpression fieldReference,
                                                           Class<T> type)

Description copied from interface: ScriptGenerator

Given a PathExpression, this method should return the target language script for retrieving the value of the field.

Specified by:

composeFieldValueReference in interface ScriptGenerator

composeFieldAttributeReference

public <T extends Expression> T composeFieldAttributeReference(Expression.PathExpression fieldReference,
                                                               String attribute,
                                                               Class<T> type)

Description copied from interface: ScriptGenerator

Given a PathExpression and an attribute name, this method should return the target language script for retrieving the value of the attribute.

Specified by:

composeFieldAttributeReference in interface ScriptGenerator

composeVariableReference

public <T extends Expression> T composeVariableReference(String variableName,
                                                         Class<T> type)

Description copied from interface: ScriptGenerator

Given a variable name this method should return script to dereference the variable. The returned Expression should be of the indicated type.

Specified by:

composeVariableReference in interface ScriptGenerator

composeList

public <T extends Expression,L extends Expression.ListExpression<T>> L composeList(List<T> list,
                                                                                         Class<L> type)

Description copied from interface: ScriptGenerator

Takes a list of string expressions and returns the target language script that corresponds to a list of string expressions.

Specified by:

composeList in interface ScriptGenerator

getNumericLiteralEquivalent

public Expression.NumericExpression getNumericLiteralEquivalent(String literal)

Description copied from interface: ScriptGenerator

Returns the numeric literal passed in target language script. The passed literal is in EFX.

Specified by:

getNumericLiteralEquivalent in interface ScriptGenerator

getStringLiteralEquivalent

public Expression.StringExpression getStringLiteralEquivalent(String literal)

Description copied from interface: ScriptGenerator

Returns the string literal in the target language. Note that the string literal passed as a parameter is already between quotes in EFX.

Specified by:

getStringLiteralEquivalent in interface ScriptGenerator

getBooleanEquivalent

public Expression.BooleanExpression getBooleanEquivalent(boolean value)

Description copied from interface: ScriptGenerator

Takes a Java Boolean value and returns the corresponding target language script.

Specified by:

getBooleanEquivalent in interface ScriptGenerator

getDateLiteralEquivalent

public Expression.DateExpression getDateLiteralEquivalent(String literal)

Specified by:

getDateLiteralEquivalent in interface ScriptGenerator

getTimeLiteralEquivalent

public Expression.TimeExpression getTimeLiteralEquivalent(String literal)

Specified by:

getTimeLiteralEquivalent in interface ScriptGenerator

getDurationLiteralEquivalent

public Expression.DurationExpression getDurationLiteralEquivalent(String literal)

Specified by:

getDurationLiteralEquivalent in interface ScriptGenerator

composeContainsCondition

public <T extends Expression,L extends Expression.ListExpression<T>> Expression.BooleanExpression composeContainsCondition(T needle,
                                                                                                                                 L haystack)

Description copied from interface: ScriptGenerator

Returns the target language script that checks whether a given list of values (haystack) contains a given value (needle).

Specified by:

composeContainsCondition in interface ScriptGenerator

composePatternMatchCondition

public Expression.BooleanExpression composePatternMatchCondition(Expression.StringExpression expression,
                                                                 String pattern)

Description copied from interface: ScriptGenerator

Returns the target language script that checks whether a given string matches the given RegEx pattern.

Specified by:

composePatternMatchCondition in interface ScriptGenerator

composeAllSatisfy

public <T extends Expression> Expression.BooleanExpression composeAllSatisfy(Expression.ListExpression<T> list,
                                                                             String variableName,
                                                                             Expression.BooleanExpression booleanExpression)

Specified by:

composeAllSatisfy in interface ScriptGenerator

composeAnySatisfies

public <T extends Expression> Expression.BooleanExpression composeAnySatisfies(Expression.ListExpression<T> list,
                                                                               String variableName,
                                                                               Expression.BooleanExpression booleanExpression)

Specified by:

composeAnySatisfies in interface ScriptGenerator

composeConditionalExpression

public <T extends Expression> T composeConditionalExpression(Expression.BooleanExpression condition,
                                                             T whenTrue,
                                                             T whenFalse,
                                                             Class<T> type)

Specified by:

composeConditionalExpression in interface ScriptGenerator

composeForExpression

public <T1 extends Expression,L1 extends Expression.ListExpression<T1>,T2 extends Expression,L2 extends Expression.ListExpression<T2>> L2 composeForExpression(String variableName,
                                                                                                                                                                                 L1 sourceList,
                                                                                                                                                                                 T2 expression,
                                                                                                                                                                                 Class<L2> targetListType)

Specified by:

composeForExpression in interface ScriptGenerator

composeParenthesizedExpression

public <T extends Expression> T composeParenthesizedExpression(T expression,
                                                               Class<T> type)

Description copied from interface: ScriptGenerator

Returns the given expression parenthesized in the target language.

Specified by:

composeParenthesizedExpression in interface ScriptGenerator

composeExternalReference

public Expression.PathExpression composeExternalReference(Expression.StringExpression externalReference)

Description copied from interface: ScriptGenerator

TODO: Not properly defined yet. When we need data from an external source, we need some script that gets that data. Getting the data is a two-step process: a) we need to access the data source, b) we need to get the actual data from the data source. This method should return the target language script that connects to the data source and permits us to subsequently get the data by using a PathExpression.

Specified by:

composeExternalReference in interface ScriptGenerator

composeFieldInExternalReference

public Expression.PathExpression composeFieldInExternalReference(Expression.PathExpression externalReference,
                                                                 Expression.PathExpression fieldReference)

Description copied from interface: ScriptGenerator

TODO: Not properly defined yet. See ScriptGenerator.composeExternalReference(eu.europa.ted.efx.model.Expression.StringExpression) for more details.

Specified by:

composeFieldInExternalReference in interface ScriptGenerator

joinPaths

public Expression.PathExpression joinPaths(Expression.PathExpression first,
                                           Expression.PathExpression second)

Description copied from interface: ScriptGenerator

Joins two given path expressions into one by placing the second after the first and using the proper delimiter.

Specified by:

joinPaths in interface ScriptGenerator

Parameters:

first - The part of the path that goes before the delimiter.

second - The part of the path that goes after the delimiter.

Returns:

composeLogicalAnd

public Expression.BooleanExpression composeLogicalAnd(Expression.BooleanExpression leftOperand,
                                                      Expression.BooleanExpression rightOperand)

BooleanExpressions

Specified by:

composeLogicalAnd in interface ScriptGenerator

composeLogicalOr

public Expression.BooleanExpression composeLogicalOr(Expression.BooleanExpression leftOperand,
                                                     Expression.BooleanExpression rightOperand)

Description copied from interface: ScriptGenerator

Returns the target language script for performing a logical OR operation on the two given operands.

Specified by:

composeLogicalOr in interface ScriptGenerator

composeLogicalNot

public Expression.BooleanExpression composeLogicalNot(Expression.BooleanExpression condition)

Description copied from interface: ScriptGenerator

Returns the target language script for performing a logical NOT operation on the given boolean expression.

Specified by:

composeLogicalNot in interface ScriptGenerator

composeExistsCondition

public Expression.BooleanExpression composeExistsCondition(Expression.PathExpression reference)

Specified by:

composeExistsCondition in interface ScriptGenerator

composeContainsCondition

public Expression.BooleanExpression composeContainsCondition(Expression.StringExpression haystack,
                                                             Expression.StringExpression needle)

Boolean functions

Specified by:

composeContainsCondition in interface ScriptGenerator

composeStartsWithCondition

public Expression.BooleanExpression composeStartsWithCondition(Expression.StringExpression text,
                                                               Expression.StringExpression startsWith)

Specified by:

composeStartsWithCondition in interface ScriptGenerator

composeEndsWithCondition

public Expression.BooleanExpression composeEndsWithCondition(Expression.StringExpression text,
                                                             Expression.StringExpression endsWith)

Specified by:

composeEndsWithCondition in interface ScriptGenerator

composeComparisonOperation

public Expression.BooleanExpression composeComparisonOperation(Expression leftOperand,
                                                               String operator,
                                                               Expression rightOperand)

Description copied from interface: ScriptGenerator

Returns the target language script that compares the two operands (for equality etc.).

Specified by:

composeComparisonOperation in interface ScriptGenerator

operator - The EFX operator that is used to compare the two operands. Do not forget to translate the operator to the target language equivalent.

composeCountOperation

public Expression.NumericExpression composeCountOperation(Expression.PathExpression nodeSet)

Numeric functions

Specified by:

composeCountOperation in interface ScriptGenerator

composeCountOperation

public Expression.NumericExpression composeCountOperation(Expression.ListExpressionBase list)

Specified by:

composeCountOperation in interface ScriptGenerator

composeToNumberConversion

public Expression.NumericExpression composeToNumberConversion(Expression.StringExpression text)

Specified by:

composeToNumberConversion in interface ScriptGenerator

composeSumOperation

public Expression.NumericExpression composeSumOperation(Expression.PathExpression nodeSet)

Specified by:

composeSumOperation in interface ScriptGenerator

composeSumOperation

public Expression.NumericExpression composeSumOperation(Expression.NumericListExpression nodeSet)

Specified by:

composeSumOperation in interface ScriptGenerator

composeStringLengthCalculation

public Expression.NumericExpression composeStringLengthCalculation(Expression.StringExpression text)

Specified by:

composeStringLengthCalculation in interface ScriptGenerator

composeNumericOperation

public Expression.NumericExpression composeNumericOperation(Expression.NumericExpression leftOperand,
                                                            String operator,
                                                            Expression.NumericExpression rightOperand)

Description copied from interface: ScriptGenerator

Given a numeric operation, this method should return the target language script that performs the operation.

Specified by:

composeNumericOperation in interface ScriptGenerator

operator - The EFX intended operator. Do not forget to translate the operator to the target language equivalent.

composeSubstringExtraction

public Expression.StringExpression composeSubstringExtraction(Expression.StringExpression text,
                                                              Expression.NumericExpression start,
                                                              Expression.NumericExpression length)

String functions

Specified by:

composeSubstringExtraction in interface ScriptGenerator

composeSubstringExtraction

public Expression.StringExpression composeSubstringExtraction(Expression.StringExpression text,
                                                              Expression.NumericExpression start)

Specified by:

composeSubstringExtraction in interface ScriptGenerator

composeToStringConversion

public Expression.StringExpression composeToStringConversion(Expression.NumericExpression number)

Specified by:

composeToStringConversion in interface ScriptGenerator

composeStringConcatenation

public Expression.StringExpression composeStringConcatenation(List<Expression.StringExpression> list)

Specified by:

composeStringConcatenation in interface ScriptGenerator

composeNumberFormatting

public Expression.StringExpression composeNumberFormatting(Expression.NumericExpression number,
                                                           Expression.StringExpression format)

Specified by:

composeNumberFormatting in interface ScriptGenerator

getStringLiteralFromUnquotedString

public Expression.StringExpression getStringLiteralFromUnquotedString(String value)

Description copied from interface: ScriptGenerator

Gets a piece of text and returns it inside quotes as expected by the target language.

Specified by:

getStringLiteralFromUnquotedString in interface ScriptGenerator

Returns:

composeToDateConversion

public Expression.DateExpression composeToDateConversion(Expression.StringExpression date)

Date functions

Specified by:

composeToDateConversion in interface ScriptGenerator

composeAddition

public Expression.DateExpression composeAddition(Expression.DateExpression date,
                                                 Expression.DurationExpression duration)

Specified by:

composeAddition in interface ScriptGenerator

composeSubtraction

public Expression.DateExpression composeSubtraction(Expression.DateExpression date,
                                                    Expression.DurationExpression duration)

Specified by:

composeSubtraction in interface ScriptGenerator

composeToTimeConversion

public Expression.TimeExpression composeToTimeConversion(Expression.StringExpression time)

Time functions

Specified by:

composeToTimeConversion in interface ScriptGenerator

composeToDayTimeDurationConversion

public Expression.DurationExpression composeToDayTimeDurationConversion(Expression.StringExpression text)

Duration functions

Specified by:

composeToDayTimeDurationConversion in interface ScriptGenerator

composeToYearMonthDurationConversion

public Expression.DurationExpression composeToYearMonthDurationConversion(Expression.StringExpression text)

Specified by:

composeToYearMonthDurationConversion in interface ScriptGenerator

composeSubtraction

public Expression.DurationExpression composeSubtraction(Expression.DateExpression startDate,
                                                        Expression.DateExpression endDate)

Specified by:

composeSubtraction in interface ScriptGenerator

composeMultiplication

public Expression.DurationExpression composeMultiplication(Expression.NumericExpression number,
                                                           Expression.DurationExpression duration)

Specified by:

composeMultiplication in interface ScriptGenerator

composeAddition

public Expression.DurationExpression composeAddition(Expression.DurationExpression left,
                                                     Expression.DurationExpression right)

Specified by:

composeAddition in interface ScriptGenerator

composeSubtraction

public Expression.DurationExpression composeSubtraction(Expression.DurationExpression left,
                                                        Expression.DurationExpression right)

Specified by:

composeSubtraction in interface ScriptGenerator