Package com.sas.metadata.remote

Interface Stream

All Superinterfaces:
CMetadata, ContentLocation, DeployedDataPackage, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
public interface Stream extends ContentLocation
Represents a stream of data. The protocol attribute describes the format of the data.

Attributes of Stream are:

Associations of Stream are:

Usage

To create an instance of this Stream, use the factory create methods.
Example: create a Stream with name "Stream_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();
 Stream myObject = (Stream) factory.createComplexMetadataObject(objectStore, "Stream_Object", MetadataObjects.STREAM, "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_PROTOCOL_NAME

      static final String ATTRIBUTE_PROTOCOL_NAME
      Constant used for the name of the Protocol attribute.

      Protocol: This attribute describes the protocol or format of the information transmitted via the stream.

      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
      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 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
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getProtocol

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

    • getProtocolState

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

    • getProtocolMaxLength

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

    • setProtocol

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

    • setProtocol

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

    • setProtocolState

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