Package com.sas.metadata.remote

Interface Target

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, Remote, Root, SecondaryType
public interface Target extends SecondaryType
Represents a variable whose values are known in one or more data sets that are available (in training data, for example) but whose values are unknown in one or more future data sets (in a score data set, for example). Data mining models use data from known variables to predict the values of target variables. Used by SAS Enterprise Miner.

Attributes of Target are:

Associations of Target are:

Usage

To create an instance of this Target, use the factory create methods.
Example: create a Target with name "Target_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();
 Target myObject = (Target) factory.createComplexMetadataObject(objectStore, "Target_Object", MetadataObjects.TARGET, "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_EVENT_NAME

      static final String ATTRIBUTE_EVENT_NAME
      Constant used for the name of the Event attribute.

      Event: The value of interest. For example, if we want to use column PURCHASE as the binary target to create a predictive model and suppose that there are two values in the target: 0,1 which map to NO and YES using a format. One of the first questions that a mining tool would ask during model training is what is, "What is the value that is to be modeled. i.e., Is it YES, or is it NO?" If YES is the event, then NO is the non-event, and vice versa.

      See Also:

    • ASSOCIATION_FITSTATISTICS_NAME

      static final String ASSOCIATION_FITSTATISTICS_NAME
      Constant used for the name of the FitStatistics association.

      FitStatistics: The fit statistics that are associated with this target.  

      See Also:

    • ASSOCIATION_OWNINGANALYTICCOLUMN_NAME

      static final String ASSOCIATION_OWNINGANALYTICCOLUMN_NAME
      Constant used for the name of the OwningAnalyticColumn association.

      OwningAnalyticColumn: The column that has a role of target.  

      See Also:

    • ASSOCIATION_TEXTUALINFORMATIONOBJECTS_NAME

      static final String ASSOCIATION_TEXTUALINFORMATIONOBJECTS_NAME
      Constant used for the name of the TextualInformationObjects association.

      TextualInformationObjects: Textual information about this target. There would be multiple text objects associated with a target. The roles would be Importance, Interaction, and Profile.  

      See Also:

    • ASSOCIATION_MODELS_NAME

      static final String ASSOCIATION_MODELS_NAME
      Constant used for the name of the Models association.

      Models: The models that act upon this target. 

      See Also:

  • Method Details

    • initializeRequiredObjects

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

    • getEvent

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

    • getEventState

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

    • getEventMaxLength

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

    • getFitStatistics

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

    • getOwningAnalyticColumns

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

    • getOwningAnalyticColumn

      AnalyticColumn getOwningAnalyticColumn() throws RemoteException, MdException
      Gets the AnalyticColumn for OwningAnalyticColumn
      Returns:
      The AnalyticColumn ( null if not set) of OwningAnalyticColumnwhich can be of type:
      AnalyticColumn
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getTextualInformationObjects

      AssociationList getTextualInformationObjects() throws RemoteException, MdException
      Gets the AssociationList of TextualInformationObjects
      Returns:
      Returns the AssociationList of TextualInformationObjects 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.

    • getModels

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

    • getFitStatistics

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

    • getOwningAnalyticColumns

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

    • getTextualInformationObjects

      AssociationList getTextualInformationObjects(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of TextualInformationObjects
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the AssociationList of TextualInformationObjects 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.

    • getModels

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

    • setEvent

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

    • setEvent

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

    • setEventState

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

    • setFitStatistics

      void setFitStatistics(AssociationList list) throws RemoteException
      Sets the FitStatistics list to be list. Objects of which can be of type:
      FitStatistic
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setFitStatistics

      void setFitStatistics(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.

    • setOwningAnalyticColumns

      void setOwningAnalyticColumns(AssociationList list) throws RemoteException
      Sets the OwningAnalyticColumns list to be list. Object of which can be of type:
      AnalyticColumn
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setOwningAnalyticColumns

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

    • setOwningAnalyticColumn

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

    • setTextualInformationObjects

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

    • setTextualInformationObjects

      void setTextualInformationObjects(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.

    • setModels

      void setModels(AssociationList list) throws RemoteException
      Sets the Models list to be list. Objects of which can be of type:
      MiningResult
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setModels

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