org.eclipse.datatools.connectivity.oda.spec.valueexpr
Class FunctionValueExpression

java.lang.Object
  extended by org.eclipse.datatools.connectivity.oda.spec.ValueExpression
      extended by org.eclipse.datatools.connectivity.oda.spec.valueexpr.AtomicValueExpression
          extended by org.eclipse.datatools.connectivity.oda.spec.valueexpr.FunctionValueExpression
Direct Known Subclasses:
CustomFunction

public abstract class FunctionValueExpression
extends AtomicValueExpression

The abstract base class for all ODA function value expressions.

A value expression may be validated by an IValidator implemented by an extension of the org.eclipse.datatools.connectivity.oda.dynamicResultSet extension point.

Since:
3.2.2 (DTP 1.7.2)

Field Summary
 
Fields inherited from class org.eclipse.datatools.connectivity.oda.spec.ValueExpression
UNKNOWN_ODA_DATA_TYPE
 
Method Summary
 ExpressionArguments getArguments()
           
 java.lang.Integer getOdaDataType()
          Gets the ODA-defined code value of this variable's data type.
 java.lang.String getQualifiedId()
          Returns the qualified id of this expression type.
 boolean ignoresDuplicateValues()
          Indicates whether this function should ignore duplicate values of its input variable(s).
 void setArguments(ExpressionArguments mArgs)
           
 void setIgnoreDuplicateValues(boolean ignoresDups)
          Specifies whether this function to ignore duplicate values of its input variable(s).
 java.lang.String toString()
           
 void validateSyntax(ValidationContext context)
          Performs syntactic validation of this expression in the specified context.
 
Methods inherited from class org.eclipse.datatools.connectivity.oda.spec.ValueExpression
getName, getVariableType, setOdaDataType, validate, validate
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getQualifiedId

public java.lang.String getQualifiedId()
Returns the qualified id of this expression type.

Overrides:
getQualifiedId in class ValueExpression
Returns:
qualified id

getArguments

public ExpressionArguments getArguments()

setArguments

public void setArguments(ExpressionArguments mArgs)

ignoresDuplicateValues

public boolean ignoresDuplicateValues()
Indicates whether this function should ignore duplicate values of its input variable(s).

Returns:
true to ignore; false otherwise

setIgnoreDuplicateValues

public void setIgnoreDuplicateValues(boolean ignoresDups)
Specifies whether this function to ignore duplicate values of its input variable(s).

Parameters:
ignoresDups - true to ignore; false otherwise

getOdaDataType

public java.lang.Integer getOdaDataType()
Description copied from class: ValueExpression
Gets the ODA-defined code value of this variable's data type. This serves as an optional hint that may have been specified based on the resolved expression.

Overrides:
getOdaDataType in class ValueExpression
Returns:
the ODA data type code of this variable, or null if not available

validateSyntax

public void validateSyntax(ValidationContext context)
                    throws OdaException
Description copied from class: ValueExpression
Performs syntactic validation of this expression in the specified context.

Specified by:
validateSyntax in class ValueExpression
Parameters:
context - context for validation; may be null which would limit the scope of validation
Throws:
OdaException - if validation failed. The concrete cause is defined by the subclass implementing this method.

toString

public java.lang.String toString()
Overrides:
toString in class ValueExpression