| 
 | ||||||||||
| 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.ResultExtensionExplorer
public class ResultExtensionExplorer
This singleton explorer is the entry point to explore and access
 the manifest of all the extensions that implement the 
 org.eclipse.datatools.connectivity.oda.dynamicResultSet extension point.
 The ResultExtensionExplorer singleton instance is retrieved 
 using the getInstance() method.
| Field Summary | |
|---|---|
| static java.lang.String | AGGREGATE_GROUP_NAME | 
| static java.lang.String | DTP_ODA_DYNAMIC_RESULT_SETS_EXT_POINT | 
| static java.lang.String | FILTER_GROUP_NAME | 
| static java.lang.String | VALUE_EXPR_GROUP_NAME | 
| Method Summary | |
|---|---|
|  AggregateDefinition | getContributedAggregateDefinition(ExtensionContributor extensionContributor,
                                  java.lang.String exprId)Gets the definition of the specified custom aggregate declared by the specified expression contributor. | 
|  AggregateDefinition[] | getContributedAggregateDefinitions(ExtensionContributor extensionContributor)Gets the collection of custom aggregate definitions declared by the specified contributor. | 
|  FilterExpressionDefinition | getContributedFilterDefinition(ExtensionContributor extensionContributor,
                               java.lang.String exprId)Gets the definition of the specified custom filter expression declared by the specified expression contributor. | 
|  FilterExpressionDefinition[] | getContributedFilterDefinitions(ExtensionContributor extensionContributor)Gets the collection of custom filter expression definitions declared by the specified contributor. | 
|  ExtensionContributor[] | getContributorsOfDataSet(java.lang.String odaDataSourceId,
                         java.lang.String odaDataSetId)Gets the collection of contributors that contribute dynamicResultSet extension to the specified data set type defined within the specified data source type. | 
|  AggregateDefinition | getExtensionAggregateDefinition(java.lang.String extensionId,
                                java.lang.String exprId)Gets the definition of the specified custom aggregate type declared by the specified extension. | 
|  AggregateDefinition[] | getExtensionAggregateDefinitions(java.lang.String extensionId)Gets the collection of custom aggregate definitions declared by the specified extension. | 
|  CombinedExpressionOperatorDefinition | getExtensionCombinedOperatorDefinition(java.lang.String extensionId,
                                       java.lang.String operatorId)Gets the definition of the specified supported or custom value expression combined operator declared by the specified extension. | 
|  CombinedExpressionOperatorDefinition[] | getExtensionCombinedOperatorDefinitions(java.lang.String extensionId)Gets the collection of supported and custom value expression combined operator definitions declared by the specified extension. | 
|  ExtensionContributor | getExtensionContributor(java.lang.String extensionId)Returns the contributor of the specified extension. | 
|  FilterExpressionDefinition | getExtensionFilterDefinition(java.lang.String extensionId,
                             java.lang.String exprId)Gets the definition of the specified custom filter expression type declared by the specified extension. | 
|  FilterExpressionDefinition[] | getExtensionFilterDefinitions(java.lang.String extensionId)Gets the collection of custom filter expression definitions declared by the specified extension. | 
|  FunctionExpressionDefinition | getExtensionFunctionDefinition(java.lang.String extensionId,
                               java.lang.String functionId)Gets the definition of the specified supported or custom value expression function declared by the specified extension. | 
|  FunctionExpressionDefinition[] | getExtensionFunctionDefinitions(java.lang.String extensionId)Gets the collection of supported and custom value expression function definitions declared by the specified extension. | 
| static ResultExtensionExplorer | getInstance()Gets the singleton instance to explore the manifest of the dynamicResultSet extensions. | 
|  void | refresh()Refresh the explorer, and allows it to get the latest extension manifests. | 
| static void | releaseInstance()Singleton instance release method. | 
| Methods inherited from class java.lang.Object | 
|---|
| equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Field Detail | 
|---|
public static final java.lang.String DTP_ODA_DYNAMIC_RESULT_SETS_EXT_POINT
public static final java.lang.String FILTER_GROUP_NAME
public static final java.lang.String AGGREGATE_GROUP_NAME
public static final java.lang.String VALUE_EXPR_GROUP_NAME
| Method Detail | 
|---|
public static ResultExtensionExplorer getInstance()
public static void releaseInstance()
public void refresh()
public ExtensionContributor[] getContributorsOfDataSet(java.lang.String odaDataSourceId,
                                                       java.lang.String odaDataSetId)
                                                throws java.lang.IllegalArgumentException,
                                                       OdaException
odaDataSourceId - id of an ODA data source extensionodaDataSetId - id of an ODA data set defined within the data source extension
ExtensionContributor;
          or an empty array if no supporting contributor is registered
OdaException
java.lang.IllegalArgumentException
public FilterExpressionDefinition[] getContributedFilterDefinitions(ExtensionContributor extensionContributor)
                                                             throws java.lang.IllegalArgumentException,
                                                                    OdaException
extensionContributor - contributor of a dynamicResultSet extension
FilterExpressionDefinition declared by the specified contributor; 
          or an empty array if none
java.lang.IllegalArgumentException
OdaException
public FilterExpressionDefinition getContributedFilterDefinition(ExtensionContributor extensionContributor,
                                                                 java.lang.String exprId)
                                                          throws java.lang.IllegalArgumentException,
                                                                 OdaException
extensionContributor - contributor of a dynamicResultSet extensionexprId - id of a custom filter expression
FilterExpressionDefinition, or null if no matching definition is found
java.lang.IllegalArgumentException
OdaException
public FilterExpressionDefinition[] getExtensionFilterDefinitions(java.lang.String extensionId)
                                                           throws java.lang.IllegalArgumentException,
                                                                  OdaException
extensionId - unique id of an extension that implements the dynamicResultSet extension point
FilterExpressionDefinition defined by the specified extension; 
          or an empty array if none
OdaException
java.lang.IllegalArgumentException
public FilterExpressionDefinition getExtensionFilterDefinition(java.lang.String extensionId,
                                                               java.lang.String exprId)
                                                        throws java.lang.IllegalArgumentException,
                                                               OdaException
extensionId - unique id of an extension that implements the dynamicResultSet extension pointexprId - id of a custom filter expression
FilterExpressionDefinition, or null if no matching definition is found
java.lang.IllegalArgumentException
OdaException
public ExtensionContributor getExtensionContributor(java.lang.String extensionId)
                                             throws OdaException
extensionId - unique id of an extension that implements the dynamicResultSet extension point
ExtensionContributor that defines its scope and capabilities
OdaException
public AggregateDefinition[] getContributedAggregateDefinitions(ExtensionContributor extensionContributor)
                                                         throws java.lang.IllegalArgumentException,
                                                                OdaException
extensionContributor - contributor of a dynamicResultSet extension
AggregateDefinition declared by the specified contributor; 
          or an empty array if none
java.lang.IllegalArgumentException - if specified argument is invalid or null
OdaException
public AggregateDefinition getContributedAggregateDefinition(ExtensionContributor extensionContributor,
                                                             java.lang.String exprId)
                                                      throws java.lang.IllegalArgumentException,
                                                             OdaException
extensionContributor - contributor of a dynamicResultSet extensionexprId - id of an aggregate type
AggregateDefinition, or null if no matching definition is found
java.lang.IllegalArgumentException - if any specified argument is invalid or null
OdaException
public AggregateDefinition[] getExtensionAggregateDefinitions(java.lang.String extensionId)
                                                       throws java.lang.IllegalArgumentException,
                                                              OdaException
extensionId - unique id of an extension that implements the dynamicResultSet extension point
AggregateDefinition defined by the specified extension; 
          or an empty array if none
java.lang.IllegalArgumentException - if specified argument is invalid or null
OdaException
public AggregateDefinition getExtensionAggregateDefinition(java.lang.String extensionId,
                                                           java.lang.String exprId)
                                                    throws java.lang.IllegalArgumentException,
                                                           OdaException
extensionId - unique id of an extension that implements the dynamicResultSet extension pointexprId - id of an aggregate type
AggregateDefinition, or null if no matching definition is found
java.lang.IllegalArgumentException - if any specified argument is null or empty
OdaException
public CombinedExpressionOperatorDefinition[] getExtensionCombinedOperatorDefinitions(java.lang.String extensionId)
                                                                               throws java.lang.IllegalArgumentException,
                                                                                      OdaException
extensionId - unique id of an extension that implements the dynamicResultSet extension point
CombinedExpressionOperatorDefinition defined by the specified extension; 
          or an empty array if none
java.lang.IllegalArgumentException - if specified argument is invalid or null
OdaException
public CombinedExpressionOperatorDefinition getExtensionCombinedOperatorDefinition(java.lang.String extensionId,
                                                                                   java.lang.String operatorId)
                                                                            throws java.lang.IllegalArgumentException,
                                                                                   OdaException
extensionId - unique id of an extension that implements the dynamicResultSet extension pointoperatorId - the id of a value expression combined operator type; 
              may be an ODA built-in operator or a custom type contributed by the extension
CombinedExpressionOperatorDefinition, or null if no matching definition is found
java.lang.IllegalArgumentException - if any specified argument is null or empty
OdaException
public FunctionExpressionDefinition[] getExtensionFunctionDefinitions(java.lang.String extensionId)
                                                               throws java.lang.IllegalArgumentException,
                                                                      OdaException
extensionId - unique id of an extension that implements the dynamicResultSet extension point
FunctionExpressionDefinition defined by the specified extension; 
          or an empty array if none
java.lang.IllegalArgumentException - if specified argument is invalid or null
OdaException
public FunctionExpressionDefinition getExtensionFunctionDefinition(java.lang.String extensionId,
                                                                   java.lang.String functionId)
                                                            throws java.lang.IllegalArgumentException,
                                                                   OdaException
extensionId - unique id of an extension that implements the dynamicResultSet extension pointfunctionId - the id of a value expression function type contributed by the extension
FunctionExpressionDefinition, or null if no matching definition is found
java.lang.IllegalArgumentException - if any specified argument is null or empty
OdaException| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||