Package com.sas.metadata.remote

Interface ColumnRange

All Superinterfaces:
CMetadata, Column, Feature, LogicalColumn, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
public interface ColumnRange extends Column
Represents a range of columns.

Attributes of ColumnRange are:

Associations of ColumnRange are:

Usage

To create an instance of this ColumnRange, use the factory create methods.
Example: create a ColumnRange with name "ColumnRange_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();
 ColumnRange myObject = (ColumnRange) factory.createComplexMetadataObject(objectStore, "ColumnRange_Object", MetadataObjects.COLUMNRANGE, "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_START_NAME

      static final String ATTRIBUTE_START_NAME
      Constant used for the name of the Start attribute.

      Start: The starting position for the range.

      See Also:

    • ATTRIBUTE_END_NAME

      static final String ATTRIBUTE_END_NAME
      Constant used for the name of the End attribute.

      End: The end position for a range.

      See Also:

    • ATTRIBUTE_PREFIX_NAME

      static final String ATTRIBUTE_PREFIX_NAME
      Constant used for the name of the Prefix attribute.

      Prefix: The prefix for this range.

      See Also:

  • Method Details

    • initializeRequiredObjects

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

    • getStart

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

    • getStartState

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

    • getEnd

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

    • getEndState

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

    • getPrefix

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

    • getPrefixState

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

    • getPrefixMaxLength

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

    • setStart

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

    • setStart

      void setStart(int inStart, int state) throws RemoteException
      Sets the Start Metadata State.
      Parameters:
      inStart - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setStart

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

    • setStart

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

    • setStartState

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

    • setEnd

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

    • setEnd

      void setEnd(int inEnd, int state) throws RemoteException
      Sets the End Metadata State.
      Parameters:
      inEnd - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setEnd

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

    • setEnd

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

    • setEndState

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

    • setPrefix

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

    • setPrefix

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

    • setPrefixState

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