Package com.sas.metadata.remote

Interface TextStore

All Superinterfaces:
CMetadata, ContentLocation, DeployedDataPackage, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root, Text
public interface TextStore extends Text
Represents storing text in the repository.

Attributes of TextStore are:

Associations of TextStore are:

Usage

To create an instance of this TextStore, use the factory create methods.
Example: create a TextStore with name "TextStore_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();
 TextStore myObject = (TextStore) factory.createComplexMetadataObject(objectStore, "TextStore_Object", MetadataObjects.TEXTSTORE, "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_STOREDTEXT_NAME

      static final String ATTRIBUTE_STOREDTEXT_NAME
      Constant used for the name of the StoredText attribute.

      StoredText: This is the actual text of the note.

      See Also:

    • ASSOCIATION_OWNINGMININGRESULT_NAME

      static final String ASSOCIATION_OWNINGMININGRESULT_NAME
      Constant used for the name of the OwningMiningResult association.

      OwningMiningResult: The mining result associated to this PMML.  

      See Also:

    • ASSOCIATION_OBJECTS_NAME

      static final String ASSOCIATION_OBJECTS_NAME
      Constant used for the name of the Objects association.

      Objects: *Unknown* 

      See Also:

  • Method Details

    • initializeRequiredObjects

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

    • getStoredText

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

    • getStoredTextState

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

    • getStoredTextMaxLength

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

    • getOwningMiningResults

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

    • getOwningMiningResult

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

    • getObjects

      AssociationList getObjects() throws RemoteException, MdException
      Gets the Association list of Objects
      Returns:
      The AssociationList of Objects 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.

    • getOwningMiningResults

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

    • getObjects

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

    • setStoredText

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

    • setStoredText

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

    • setStoredTextState

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

    • setOwningMiningResults

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

    • setOwningMiningResults

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

    • setOwningMiningResult

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

    • setObjects

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

    • setObjects

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