Package com.sas.metadata.remote

Interface RowSelector

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, QueryClause, Remote, Root, SecondaryType
public interface RowSelector extends QueryClause
Used to document a SAS DATA step SELECT statement.

Attributes of RowSelector are:

Associations of RowSelector are:

Usage

To create an instance of this RowSelector, use the factory create methods.
Example: create a RowSelector with name "RowSelector_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();
 RowSelector myObject = (RowSelector) factory.createComplexMetadataObject(objectStore, "RowSelector_Object", MetadataObjects.ROWSELECTOR, "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_ROWSSELECTED_NAME

      static final String ATTRIBUTE_ROWSSELECTED_NAME
      Constant used for the name of the RowsSelected attribute.

      RowsSelected: enumeration: AllRows, Conditions, UserDefinedStatements

      See Also:

    • ASSOCIATION_OWNINGCLASSIFIERMAP_NAME

      static final String ASSOCIATION_OWNINGCLASSIFIERMAP_NAME
      Constant used for the name of the OwningClassifierMap association.

      OwningClassifierMap: The classifier map that uses this row selector. 

      See Also:

  • Method Details

    • initializeRequiredObjects

      void initializeRequiredObjects() throws RemoteException
      (S) This initializes the Required Objects(Roles) which are:
      OwningClassifierMap
      Specified by:
      initializeRequiredObjects in interface MdObjectBaseUtil
      Specified by:
      initializeRequiredObjects in interface QueryClause
      Specified by:
      initializeRequiredObjects in interface Root
      Specified by:
      initializeRequiredObjects in interface SecondaryType
      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 MdObjectBase
      Specified by:
      initializePredObjects in interface QueryClause
      Specified by:
      initializePredObjects in interface Root
      Specified by:
      initializePredObjects in interface SecondaryType
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getRowsSelected

      String getRowsSelected() throws RemoteException
      Gets the String value of RowsSelected
      Returns:
      The RowsSelected
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getRowsSelectedState

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

    • getRowsSelectedMaxLength

      int getRowsSelectedMaxLength() throws RemoteException
      Gets the maximum length of RowsSelected
      Returns:
      The max size
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getOwningClassifierMaps

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

    • getOwningClassifierMap

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

    • getOwningClassifierMaps

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

    • setRowsSelected

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

    • setRowsSelected

      void setRowsSelected(String inRowsSelected, int state) throws RemoteException
      Sets the RowsSelected Metadata State.
      Parameters:
      inRowsSelected - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setRowsSelectedState

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

    • setOwningClassifierMaps

      void setOwningClassifierMaps(AssociationList list) throws RemoteException
      Sets the OwningClassifierMaps list to be list. Objects of which can be of type:
      ClassifierMap
      Select
      Join
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setOwningClassifierMaps

      void setOwningClassifierMaps(AssociationList list, int state) throws RemoteException
      Sets the OwningClassifierMaps list to be list. Objects of which can be of type:
      ClassifierMap
      Select
      Join
      Parameters:
      list - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setOwningClassifierMap

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