Package com.sas.metadata.remote

Interface LogicalColumn

All Superinterfaces:
CMetadata, Feature, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
All Known Subinterfaces:
CalculatedMeasure, Column, ColumnRange, Measure
public interface LogicalColumn extends Feature
The supertype for Column, which is part of a relational table, and Measure, which is used with OLAP types.

Attributes of LogicalColumn are:

Associations of LogicalColumn are:

Usage

To create an instance of this LogicalColumn, use the factory create methods.
Example: create a LogicalColumn with name "LogicalColumn_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();
 LogicalColumn myObject = (LogicalColumn) factory.createComplexMetadataObject(objectStore, "LogicalColumn_Object", MetadataObjects.LOGICALCOLUMN, "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_SASFORMAT_NAME

      static final String ATTRIBUTE_SASFORMAT_NAME
      Constant used for the name of the SASFormat attribute.

      SASFormat: This attribute contains the SAS format associated with this column.

      See Also:

    • ATTRIBUTE_SASINFORMAT_NAME

      static final String ATTRIBUTE_SASINFORMAT_NAME
      Constant used for the name of the SASInformat attribute.

      SASInformat: This attribute contains the SAS informat associated with this column.

      See Also:

    • ATTRIBUTE_COLUMNLENGTH_NAME

      static final String ATTRIBUTE_COLUMNLENGTH_NAME
      Constant used for the name of the ColumnLength attribute.

      ColumnLength: This attribute contains the length of the column. When this type is used to represent a physical column in a DBMS, the length is the DBMS length value. The SASColumnLength should be the same as this value, unless the length is too long and will be truncated by SAS software.

      See Also:

    • ATTRIBUTE_COLUMNTYPE_NAME

      static final String ATTRIBUTE_COLUMNTYPE_NAME
      Constant used for the name of the ColumnType attribute.

      ColumnType: The type of the column as defined in the DBMS. This is an integer value that indicates the SQL type.

    • ARRAY = 2003
    • BIGINT = -5
    • BINARY = -2
    • BIT = -7
    • BLOB = 2004
    • CHAR = 1
    • CLOB = 2005
    • DATE = 91
    • DECIMAL = 3
    • DISTINCT = 2001
    • DOUBLE = 8
    • FLOAT = 6
    • INTEGER = 4
    • JAVA_OBJECT = 2000
    • LONGVARBINARY = -4
    • LONGVARCHAR = -1
    • NULL = 0
    • NUMERIC = 2
    • OTHER = 1111
    • REAL = 7
    • REF = 2006
    • SMALLINT = 5
    • STRUCT = 2002
    • TIME = 92
    • TIMESTAMP = 93
    • TINYINT = -6
    • VARBINARY = -3
    • VARCHAR = 12
      • See Also:

    • ATTRIBUTE_COLUMNNAME_NAME

      static final String ATTRIBUTE_COLUMNNAME_NAME
      Constant used for the name of the ColumnName attribute.

      ColumnName: This attribute is the name of the column as it is defined in a DBMS. ColumnName will often be set to match the value for SASColumnName. This attribute is not used by SAS Data Integration Studio.

      See Also:

  • Method Details

    • initializeRequiredObjects

      void initializeRequiredObjects() throws RemoteException
      (S) This initializes the Required Objects(Roles) which are:
      Specified by:
      initializeRequiredObjects in interface Feature
      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 Feature
      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.

    • getSASFormat

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

    • getSASFormatState

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

    • getSASFormatMaxLength

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

    • getSASInformat

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

    • getSASInformatState

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

    • getSASInformatMaxLength

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

    • getColumnLength

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

    • getColumnLengthState

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

    • getColumnType

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

    • getColumnTypeState

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

    • getColumnName

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

    • getColumnNameState

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

    • getColumnNameMaxLength

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

    • setSASFormat

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

    • setSASFormat

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

    • setSASFormatState

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

    • setSASInformat

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

    • setSASInformat

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

    • setSASInformatState

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

    • setColumnLength

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

    • setColumnLength

      void setColumnLength(int inColumnLength, int state) throws RemoteException
      Sets the ColumnLength Metadata State.
      Parameters:
      inColumnLength - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setColumnLength

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

    • setColumnLength

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

    • setColumnLengthState

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

    • setColumnType

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

    • setColumnType

      void setColumnType(int inColumnType, int state) throws RemoteException
      Sets the ColumnType Metadata State.
      Parameters:
      inColumnType - int
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setColumnType

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

    • setColumnType

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

    • setColumnTypeState

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

    • setColumnName

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

    • setColumnName

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

    • setColumnNameState

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