|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.datatools.connectivity.oda.spec.manifest.FilterExpressionDefinition
public class FilterExpressionDefinition
Represents the definition of a contributed filter expression type, as specifed in an extension of the org.eclipse.datatools.connectivity.oda.dynamicResultSet extension point.
Field Summary | |
---|---|
static java.lang.String |
ATTR_CLASS
|
static java.lang.String |
ATTR_DESC
|
static java.lang.String |
ATTR_ID
|
static java.lang.String |
ATTR_MAX_ARGS
|
static java.lang.String |
ATTR_MIN_ARGS
|
static java.lang.String |
ATTR_NAME
|
static java.lang.String |
ATTR_NEGATABLE
|
static java.lang.String |
ATTR_OPTIONABLE
|
static java.lang.String |
ELEMENT_NAME
|
Method Summary | |
---|---|
CustomExpression |
createExpression()
Creates and returns an instance of CustomExpression for use in an ODA filter specification, based on the class defined in the attribute specified in this definition. |
CustomExpression |
createExpression(ExpressionVariable variable,
ExpressionArguments args)
Creates and returns an instance of CustomExpression for use in an ODA filter specification, based on the class defined in the attribute specified in this definition. |
ExtensionContributor |
getContributor()
Returns the contributor of this type of custom expression. |
java.lang.String |
getDeclaringExtensionId()
Gets the unique id of the dynamicResultSets extension that declares this type of custom filter expression. |
java.lang.String |
getDescription()
Gets the brief translateable description of this type of filter expression. |
java.lang.String |
getDisplayName()
Gets the translateable name that can be used to refer to this particular expression in dialogs presented to the user. |
java.lang.String |
getId()
Gets the id that uniquely identifies this type of custom filter expression within the contributing extension. |
static java.lang.String |
getIdAttributeValue(org.eclipse.core.runtime.IConfigurationElement exprElement)
For internal use only. |
java.lang.Integer |
getMaxArguments()
Gets the maximum number of argument values required by this expression type. |
java.lang.Integer |
getMinArguments()
Gets the minimum number of argument values required by this expression type. |
IValidator |
getValidator()
Gets the concrete class that implements the IValidator to validate this expression. |
VariableRestrictions |
getVariableRestrictions()
Gets the restriction info on the types of expression variable that can be applied with this type of filter expression. |
boolean |
isNegatable()
Indicates whether this expression can be negated, i.e. |
boolean |
isOptionable()
Indicates whether this expression can be optional and skipped in a filter specification, if none of its expected argument values are provided. |
boolean |
supportsDataSetType(java.lang.String odaDataSourceId,
java.lang.String odaDataSetId)
Indicates whether this type of custom filter expression supports the specified data set type of the specified data source type. |
boolean |
supportsUnboundedMaxArguments()
Indicates whether this expression type has no upper limit on the number of argument values. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String ELEMENT_NAME
public static final java.lang.String ATTR_ID
public static final java.lang.String ATTR_NAME
public static final java.lang.String ATTR_DESC
public static final java.lang.String ATTR_CLASS
public static final java.lang.String ATTR_MIN_ARGS
public static final java.lang.String ATTR_MAX_ARGS
public static final java.lang.String ATTR_NEGATABLE
public static final java.lang.String ATTR_OPTIONABLE
Method Detail |
---|
public static java.lang.String getIdAttributeValue(org.eclipse.core.runtime.IConfigurationElement exprElement) throws OdaException
OdaException
public CustomExpression createExpression() throws OdaException
CustomExpression
or its subclass
OdaException
public CustomExpression createExpression(ExpressionVariable variable, ExpressionArguments args) throws OdaException
variable
- the expression variable to set on the created instance; may be nullargs
- the expression arguments to set on the created instance; may be null
CustomExpression
or its subclass
OdaException
public boolean supportsDataSetType(java.lang.String odaDataSourceId, java.lang.String odaDataSetId)
odaDataSourceId
- id of an ODA data source extensionodaDataSetId
- id of an ODA data set defined within the data source extension
public java.lang.String getDeclaringExtensionId()
public java.lang.String getId()
public java.lang.String getDisplayName()
public java.lang.String getDescription()
public ExtensionContributor getContributor()
ExtensionContributor
that defines its scope and capabilitiespublic IValidator getValidator() throws OdaException
IValidator
to validate this expression.
OdaException
- if exception occurs in instantiating its defined validator classpublic java.lang.Integer getMinArguments()
public boolean supportsUnboundedMaxArguments()
public java.lang.Integer getMaxArguments()
#supportsUnboundedMaxArguments()}
public boolean isNegatable()
public boolean isOptionable()
public VariableRestrictions getVariableRestrictions()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |