Package com.activeviam.copper

Class DatabaseSelectionHelper

java.lang.Object
com.activeviam.copper.DatabaseSelectionHelper
@Deprecated(since="6.0.7", forRemoval=true) public class DatabaseSelectionHelper extends Object
Deprecated, for removal: This API element is subject to removal in a future version.
Helper object for the Copper context, containing additional information about the underlying database such as its selection and schema.

  • Constructor Summary

    Constructors
    Constructor
    Description
    DatabaseSelectionHelper(ISelectionDescription selection, IDatabaseSchemaEntityResolver resolver)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    ensureFieldExists(String field)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Ensures the given field exists in the selection.
    void
    ensureFieldsExists(String[] fields)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Ensures the given field exists in the selection.
    String
    getBaseStore()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Gets the name of the base store.
    ReachableField
    getSelectionField(String name)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Retrieves the given field from the selection.
    int
    getType(String selectionFieldName)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the type of the given field.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • DatabaseSelectionHelper

      public DatabaseSelectionHelper(ISelectionDescription selection, IDatabaseSchemaEntityResolver resolver)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Constructor.
      Parameters:
      selection - The selection of the schema containing the target cube
      resolver - The meta-data about the database on which the schema containing the target cube is built

  • Method Details

    • ensureFieldExists

      public void ensureFieldExists(String field)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Ensures the given field exists in the selection.
      Parameters:
      field - name of the field

    • ensureFieldsExists

      public void ensureFieldsExists(String[] fields)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Ensures the given field exists in the selection.
      Parameters:
      fields - name of the field

    • getSelectionField

      public ReachableField getSelectionField(String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Retrieves the given field from the selection.
      Parameters:
      name - name of the field
      Returns:
      the field from the selection

    • getType

      public int getType(String selectionFieldName)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the type of the given field.
      Parameters:
      selectionFieldName - The field name
      Returns:
      the field's type

    • getBaseStore

      public String getBaseStore()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Gets the name of the base store.
      Returns:
      the name of the base store