Package com.sas.metadata.remote

Interface Variable

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, Remote, Root, SecondaryType
public interface Variable extends SecondaryType
Used to define substitution strings and the replacement values.

Attributes of Variable are:

Associations of Variable are:

Usage

To create an instance of this Variable, use the factory create methods.
Example: create a Variable with name "Variable_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();
 Variable myObject = (Variable) factory.createComplexMetadataObject(objectStore, "Variable_Object", MetadataObjects.VARIABLE, "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_MARKER_NAME

      static final String ATTRIBUTE_MARKER_NAME
      Constant used for the name of the Marker attribute.

      Marker: The marker that needs to be replaced. This is the substitution string that should be replaced.

      See Also:

    • ATTRIBUTE_VALUETYPE_NAME

      static final String ATTRIBUTE_VALUETYPE_NAME
      Constant used for the name of the ValueType attribute.

      ValueType: The type of the value to replace the marker with. May be used to specify the name of the attribute contained in the associated metadata object that should be used in the replacement.

      See Also:

    • ASSOCIATION_ASSOCIATEDOBJECT_NAME

      static final String ASSOCIATION_ASSOCIATEDOBJECT_NAME
      Constant used for the name of the AssociatedObject association.

      AssociatedObject: The object that contains the substitution values.  

      See Also:

    • ASSOCIATION_OWNINGTRANSFORMATION_NAME

      static final String ASSOCIATION_OWNINGTRANSFORMATION_NAME
      Constant used for the name of the OwningTransformation association.

      OwningTransformation: The owning transformation for this variable.  

      See Also:

  • Method Details

    • initializeRequiredObjects

      void initializeRequiredObjects() throws RemoteException
      (S) This initializes the Required Objects(Roles) which are:
      OwningTransformation
      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:
      AssociatedObject
      OwningTransformation
      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.

    • getMarker

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

    • getMarkerState

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

    • getMarkerMaxLength

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

    • getValueType

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

    • getValueTypeState

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

    • getValueTypeMaxLength

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

    • getAssociatedObjects

      AssociationList getAssociatedObjects() throws RemoteException, MdException
      Gets the AssociationList of AssociatedObjects
      Returns:
      Returns the AssociationList of AssociatedObjects which can be of type:
      All types
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException

    • getAssociatedObject

      Root getAssociatedObject() throws RemoteException, MdException
      Gets the Root for AssociatedObject
      Returns:
      The Root ( null if not set) of AssociatedObjectwhich can be of type:
      All types
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getOwningTransformations

      AssociationList getOwningTransformations() throws RemoteException, MdException
      Gets the AssociationList of OwningTransformations
      Returns:
      Returns the AssociationList of OwningTransformations which can be of type:
      AbstractTransformation
      TransformationStep
      SyncStep
      TransformationActivity
      FeatureMap
      ColumnHierarchy
      Transformation
      ClassifierMap
      Select
      Join
      AbstractJob
      Job
      JFJob
      MiningResult
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException

    • getOwningTransformation

      AbstractTransformation getOwningTransformation() throws RemoteException, MdException
      Gets the AbstractTransformation for OwningTransformation
      Returns:
      The AbstractTransformation ( null if not set) of OwningTransformationwhich can be of type:
      AbstractTransformation
      TransformationStep
      SyncStep
      TransformationActivity
      FeatureMap
      ColumnHierarchy
      Transformation
      ClassifierMap
      Select
      Join
      AbstractJob
      Job
      JFJob
      MiningResult
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getAssociatedObjects

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

    • getOwningTransformations

      AssociationList getOwningTransformations(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of OwningTransformations
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the AssociationList of OwningTransformations which can be of type:
      AbstractTransformation
      TransformationStep
      SyncStep
      TransformationActivity
      FeatureMap
      ColumnHierarchy
      Transformation
      ClassifierMap
      Select
      Join
      AbstractJob
      Job
      JFJob
      MiningResult
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • setMarker

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

    • setMarker

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

    • setMarkerState

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

    • setValueType

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

    • setValueType

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

    • setValueTypeState

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

    • setAssociatedObjects

      void setAssociatedObjects(AssociationList list) throws RemoteException
      Sets the AssociatedObjects list to be list. Object of which can be of type:
      All types
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setAssociatedObjects

      void setAssociatedObjects(AssociationList list, int state) throws RemoteException
      Sets the AssociatedObjects list to be list. Object of which can be of type:
      All types
      Parameters:
      list - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setAssociatedObject

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

    • setOwningTransformations

      void setOwningTransformations(AssociationList list) throws RemoteException
      Sets the OwningTransformations list to be list. Object of which can be of type:
      AbstractTransformation
      TransformationStep
      SyncStep
      TransformationActivity
      FeatureMap
      ColumnHierarchy
      Transformation
      ClassifierMap
      Select
      Join
      AbstractJob
      Job
      JFJob
      MiningResult
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setOwningTransformations

      void setOwningTransformations(AssociationList list, int state) throws RemoteException
      Sets the OwningTransformations list to be list. Object of which can be of type:
      AbstractTransformation
      TransformationStep
      SyncStep
      TransformationActivity
      FeatureMap
      ColumnHierarchy
      Transformation
      ClassifierMap
      Select
      Join
      AbstractJob
      Job
      JFJob
      MiningResult
      Parameters:
      list - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setOwningTransformation

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