Package com.sas.metadata.remote

Interface Select

All Superinterfaces:
AbstractTransformation, ClassifierMap, CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root, Transformation
public interface Select extends ClassifierMap
Used to document an SQL select statement.

Attributes of Select are:

Associations of Select are:

Usage

To create an instance of this Select, use the factory create methods.
Example: create a Select with name "Select_Object", in repository "AAAAAAAA".
 // create a store to contain your objects for this change. If you do not have an existing object
 // or store to use.  You may obtain the store from another object by using Object.getObjectStore().
 MdFactory factory; //where "factory" is a valid MdFactory instance
 MdObjectStore objectStore = factory.createObjectStore();
 Select myObject = (Select) factory.createComplexMetadataObject(objectStore, "Select_Object", MetadataObjects.SELECT, "AAAAAAAA");
 myObject.updateMetadataAll();  // Write object to server
 objectStore.dispose();  // dispose of the object store if it is no longer needed

Behavior

  • Attributes and associations for this object can be retrieved by using the methods in MdOMIUtil.
  • When changes are made to the object, either by setting an attribute or adding objects to a particular association, they can be persisted to the metadata server with the updateMetadataAll method.
  • If an object needs to be deleted, the delete method can be used. This will flag the object as being deleted on the client, and will require an update call to persist the change to the server.

Dependencies

This class depends on objects being contained in an MdObjectStore. Object stores should be disposed of when they are no longer needed as this will help clean up memory. Disposing an object store will dispose of all objects contained within that store.

Since:
9.0

  • Field Details

    • ATTRIBUTE_ISPARSEALLOWED_NAME

      static final String ATTRIBUTE_ISPARSEALLOWED_NAME
      Constant used for the name of the IsParseAllowed attribute.

      IsParseAllowed: If true then the query visuals should attempt to parse and display the query in a GUI manner. This provides a way to prevent incorrect parsing of a query.

      See Also:

    • ATTRIBUTE_ISSUBSTITUTIONALLOWED_NAME

      static final String ATTRIBUTE_ISSUBSTITUTIONALLOWED_NAME
      Constant used for the name of the IsSubstitutionAllowed attribute.

      IsSubstitutionAllowed: If true then we may need to substitute physical names on the input sources before the query can be run. If true then this also implies that all of the inputs are maintained and correct. This would likely be set to false by any process that does not understand the Query's variable mechanism.

      See Also:

    • ASSOCIATION_GROUPBYFORSELECT_NAME

      static final String ASSOCIATION_GROUPBYFORSELECT_NAME
      Constant used for the name of the GroupByForSelect association.

      GroupByForSelect: The groupby statement for the select object. 

      See Also:

    • ASSOCIATION_HAVINGFORSELECT_NAME

      static final String ASSOCIATION_HAVINGFORSELECT_NAME
      Constant used for the name of the HavingForSelect association.

      HavingForSelect: The having statement of this select object. 

      See Also:

    • ASSOCIATION_ORDERBYFORSELECT_NAME

      static final String ASSOCIATION_ORDERBYFORSELECT_NAME
      Constant used for the name of the OrderByForSelect association.

      OrderByForSelect: The orderby statement of the select object. 

      See Also:

    • ASSOCIATION_WHEREFORSELECT_NAME

      static final String ASSOCIATION_WHEREFORSELECT_NAME
      Constant used for the name of the WhereForSelect association.

      WhereForSelect: The where clause for this select object. 

      See Also:

  • Method Details

    • initializeRequiredObjects

      void initializeRequiredObjects() throws RemoteException
      (S) This initializes the Required Objects(Roles) which are:
      Specified by:
      initializeRequiredObjects in interface AbstractTransformation
      Specified by:
      initializeRequiredObjects in interface ClassifierMap
      Specified by:
      initializeRequiredObjects in interface MdObjectBaseUtil
      Specified by:
      initializeRequiredObjects in interface PrimaryType
      Specified by:
      initializeRequiredObjects in interface Root
      Specified by:
      initializeRequiredObjects in interface Transformation
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • initializePredObjects

      void initializePredObjects() throws RemoteException
      (S) Adds the Associated objects to the predObjects which are:
      Specified by:
      initializePredObjects in interface AbstractTransformation
      Specified by:
      initializePredObjects in interface ClassifierMap
      Specified by:
      initializePredObjects in interface MdObjectBase
      Specified by:
      initializePredObjects in interface PrimaryType
      Specified by:
      initializePredObjects in interface Root
      Specified by:
      initializePredObjects in interface Transformation
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getIsParseAllowed

      int getIsParseAllowed() throws RemoteException
      Gets the int value of IsParseAllowed
      Returns:
      The IsParseAllowed
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getIsParseAllowedState

      int getIsParseAllowedState() throws RemoteException
      Gets the Metadata State of IsParseAllowed
      Returns:
      The State.
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getIsSubstitutionAllowed

      int getIsSubstitutionAllowed() throws RemoteException
      Gets the int value of IsSubstitutionAllowed
      Returns:
      The IsSubstitutionAllowed
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getIsSubstitutionAllowedState

      int getIsSubstitutionAllowedState() throws RemoteException
      Gets the Metadata State of IsSubstitutionAllowed
      Returns:
      The State.
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getGroupByForSelects

      AssociationList getGroupByForSelects() throws RemoteException, MdException
      Gets the Association list of GroupByForSelects
      Returns:
      The AssociationList of GroupByForSelects which can be of type:
      GroupByClause
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getGroupByForSelect

      GroupByClause getGroupByForSelect() throws RemoteException, MdException
      Gets the GroupByClause for GroupByForSelect
      Returns:
      The GroupByClause ( null if not set ) of GroupByForSelect which can be of type:
      GroupByClause
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getHavingForSelects

      AssociationList getHavingForSelects() throws RemoteException, MdException
      Gets the Association list of HavingForSelects
      Returns:
      The AssociationList of HavingForSelects which can be of type:
      HavingClause
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getHavingForSelect

      HavingClause getHavingForSelect() throws RemoteException, MdException
      Gets the HavingClause for HavingForSelect
      Returns:
      The HavingClause ( null if not set ) of HavingForSelect which can be of type:
      HavingClause
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getOrderByForSelects

      AssociationList getOrderByForSelects() throws RemoteException, MdException
      Gets the Association list of OrderByForSelects
      Returns:
      The AssociationList of OrderByForSelects which can be of type:
      OrderByClause
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getOrderByForSelect

      OrderByClause getOrderByForSelect() throws RemoteException, MdException
      Gets the OrderByClause for OrderByForSelect
      Returns:
      The OrderByClause ( null if not set ) of OrderByForSelect which can be of type:
      OrderByClause
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getWhereForSelects

      AssociationList getWhereForSelects() throws RemoteException, MdException
      Gets the Association list of WhereForSelects
      Returns:
      The AssociationList of WhereForSelects which can be of type:
      WhereClause
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getWhereForSelect

      WhereClause getWhereForSelect() throws RemoteException, MdException
      Gets the WhereClause for WhereForSelect
      Returns:
      The WhereClause ( null if not set ) of WhereForSelect which can be of type:
      WhereClause
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getGroupByForSelects

      AssociationList getGroupByForSelects(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of GroupByForSelects
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the GroupByForSelects which can be of type:
      GroupByClause
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getHavingForSelects

      AssociationList getHavingForSelects(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of HavingForSelects
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the HavingForSelects which can be of type:
      HavingClause
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getOrderByForSelects

      AssociationList getOrderByForSelects(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of OrderByForSelects
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the OrderByForSelects which can be of type:
      OrderByClause
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getWhereForSelects

      AssociationList getWhereForSelects(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of WhereForSelects
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the WhereForSelects which can be of type:
      WhereClause
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • setIsParseAllowed

      void setIsParseAllowed(int inIsParseAllowed) throws RemoteException
      Sets the IsParseAllowed value and sets the state to MetadataState.LOCAL.
      Parameters:
      inIsParseAllowed - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsParseAllowed

      void setIsParseAllowed(int inIsParseAllowed, int state) throws RemoteException
      Sets the IsParseAllowed Metadata State.
      Parameters:
      inIsParseAllowed - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsParseAllowed

      void setIsParseAllowed(String inIsParseAllowed) throws RemoteException
      Sets the IsParseAllowed value and sets the state to MetadataState.LOCAL.
      Parameters:
      inIsParseAllowed - String
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsParseAllowed

      void setIsParseAllowed(String inIsParseAllowed, int state) throws RemoteException
      Sets the IsParseAllowed value and Metadata State.
      Parameters:
      inIsParseAllowed - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsParseAllowedState

      void setIsParseAllowedState(int state) throws RemoteException
      Sets the Metadata State of IsParseAllowed.
      Parameters:
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsSubstitutionAllowed

      void setIsSubstitutionAllowed(int inIsSubstitutionAllowed) throws RemoteException
      Sets the IsSubstitutionAllowed value and sets the state to MetadataState.LOCAL.
      Parameters:
      inIsSubstitutionAllowed - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsSubstitutionAllowed

      void setIsSubstitutionAllowed(int inIsSubstitutionAllowed, int state) throws RemoteException
      Sets the IsSubstitutionAllowed Metadata State.
      Parameters:
      inIsSubstitutionAllowed - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsSubstitutionAllowed

      void setIsSubstitutionAllowed(String inIsSubstitutionAllowed) throws RemoteException
      Sets the IsSubstitutionAllowed value and sets the state to MetadataState.LOCAL.
      Parameters:
      inIsSubstitutionAllowed - String
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsSubstitutionAllowed

      void setIsSubstitutionAllowed(String inIsSubstitutionAllowed, int state) throws RemoteException
      Sets the IsSubstitutionAllowed value and Metadata State.
      Parameters:
      inIsSubstitutionAllowed - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setIsSubstitutionAllowedState

      void setIsSubstitutionAllowedState(int state) throws RemoteException
      Sets the Metadata State of IsSubstitutionAllowed.
      Parameters:
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setGroupByForSelects

      void setGroupByForSelects(AssociationList list) throws RemoteException
      Sets the GroupByForSelects list to be list. Objects of which can be of type:
      GroupByClause
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setGroupByForSelects

      void setGroupByForSelects(AssociationList list, int state) throws RemoteException
      Sets the GroupByForSelects list to be list. Objects of which can be of type:
      GroupByClause
      Parameters:
      list - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setGroupByForSelect

      void setGroupByForSelect(GroupByClause inObject) throws RemoteException
      Sets the GroupByForSelects list 0th element to be inObject.
      Parameters:
      inObject - GroupByClause
      Throws:
      RemoteException - If error communicating with remote object.

    • setHavingForSelects

      void setHavingForSelects(AssociationList list) throws RemoteException
      Sets the HavingForSelects list to be list. Objects of which can be of type:
      HavingClause
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setHavingForSelects

      void setHavingForSelects(AssociationList list, int state) throws RemoteException
      Sets the HavingForSelects list to be list. Objects of which can be of type:
      HavingClause
      Parameters:
      list - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setHavingForSelect

      void setHavingForSelect(HavingClause inObject) throws RemoteException
      Sets the HavingForSelects list 0th element to be inObject.
      Parameters:
      inObject - HavingClause
      Throws:
      RemoteException - If error communicating with remote object.

    • setOrderByForSelects

      void setOrderByForSelects(AssociationList list) throws RemoteException
      Sets the OrderByForSelects list to be list. Objects of which can be of type:
      OrderByClause
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setOrderByForSelects

      void setOrderByForSelects(AssociationList list, int state) throws RemoteException
      Sets the OrderByForSelects list to be list. Objects of which can be of type:
      OrderByClause
      Parameters:
      list - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setOrderByForSelect

      void setOrderByForSelect(OrderByClause inObject) throws RemoteException
      Sets the OrderByForSelects list 0th element to be inObject.
      Parameters:
      inObject - OrderByClause
      Throws:
      RemoteException - If error communicating with remote object.

    • setWhereForSelects

      void setWhereForSelects(AssociationList list) throws RemoteException
      Sets the WhereForSelects list to be list. Objects of which can be of type:
      WhereClause
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setWhereForSelects

      void setWhereForSelects(AssociationList list, int state) throws RemoteException
      Sets the WhereForSelects list to be list. Objects of which can be of type:
      WhereClause
      Parameters:
      list - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setWhereForSelect

      void setWhereForSelect(WhereClause inObject) throws RemoteException
      Sets the WhereForSelects list 0th element to be inObject.
      Parameters:
      inObject - WhereClause
      Throws:
      RemoteException - If error communicating with remote object.