Package com.sas.metadata.remote

Interface QueryClause

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, Remote, Root, SecondaryType
All Known Subinterfaces:
GroupByClause, HavingClause, OnClause, OrderByClause, RowSelector, WhereClause
public interface QueryClause extends SecondaryType
This abstract type represents types that are used to define the transformations that are performed. These include types that subset, group and order data.

Attributes of QueryClause are:

Associations of QueryClause are:

Usage

To create an instance of this QueryClause, use the factory create methods.
Example: create a QueryClause with name "QueryClause_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();
 QueryClause myObject = (QueryClause) factory.createComplexMetadataObject(objectStore, "QueryClause_Object", MetadataObjects.QUERYCLAUSE, "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

    • ASSOCIATION_COLUMNS_NAME

      static final String ASSOCIATION_COLUMNS_NAME
      Constant used for the name of the Columns association.

      Columns: The columns used in this clause.  

      See Also:

    • ASSOCIATION_SOURCECODE_NAME

      static final String ASSOCIATION_SOURCECODE_NAME
      Constant used for the name of the SourceCode association.

      SourceCode: The stored code for this query clause.  

      See Also:

  • Method Details

    • initializeRequiredObjects

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

    • getColumns

      AssociationList getColumns() throws RemoteException, MdException
      Gets the AssociationList of Columns
      Returns:
      Returns the AssociationList of Columns which can be of type:
      Column
      ColumnRange
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getSourceCodes

      AssociationList getSourceCodes() throws RemoteException, MdException
      Gets the AssociationList of SourceCodes
      Returns:
      Returns the AssociationList of SourceCodes which can be of type:
      Text
      TextStore
      SASCatalogEntry
      File
      ArchiveFile
      ArchiveEntry
      Document
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException

    • getSourceCode

      Text getSourceCode() throws RemoteException, MdException
      Gets the Text for SourceCode
      Returns:
      The Text ( null if not set) of SourceCodewhich can be of type:
      Text
      TextStore
      SASCatalogEntry
      File
      ArchiveFile
      ArchiveEntry
      Document
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getColumns

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

    • getSourceCodes

      AssociationList getSourceCodes(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of SourceCodes
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the AssociationList of SourceCodes which can be of type:
      Text
      TextStore
      SASCatalogEntry
      File
      ArchiveFile
      ArchiveEntry
      Document
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • setColumns

      void setColumns(AssociationList list) throws RemoteException
      Sets the Columns list to be list. Objects of which can be of type:
      Column
      ColumnRange
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setColumns

      void setColumns(AssociationList inObjects, int state) throws RemoteException
      Sets the entire AssociationList to match the passed in Vector, sets the state of the AssociationList
      Parameters:
      inObjects - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setSourceCodes

      void setSourceCodes(AssociationList list) throws RemoteException
      Sets the SourceCodes list to be list. Object of which can be of type:
      Text
      TextStore
      SASCatalogEntry
      File
      ArchiveFile
      ArchiveEntry
      Document
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setSourceCodes

      void setSourceCodes(AssociationList list, int state) throws RemoteException
      Sets the SourceCodes list to be list. Object of which can be of type:
      Text
      TextStore
      SASCatalogEntry
      File
      ArchiveFile
      ArchiveEntry
      Document
      Parameters:
      list - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setSourceCode

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