*** This class provides Binary Compatibility only, not Source Compatibility ***

com.sas.services.storedprocess
Class GenericStream

com.sas.services.storedprocess.GenericStream

All Implemented Interfaces:

com.sas.storage.editableproperties.LocalizableProperties, java.io.Serializable

Direct Known Subclasses:

XMLStream

public class GenericStream
implements java.io.Serializable, com.sas.storage.editableproperties.LocalizableProperties

Describes a GenericStream data source or target. For data sources the properties of this object used by the Stored Process service are the fileref name and whether rewinding is allowed; for data targets only the fileref name is used. Other properties are solely for client use.

Since:

9.2

See Also:

Serialized Form

Field Summary

protected org.w3c.dom.Element

_streamElement

Method Summary

boolean	allowsRewinds() Determines whether the stream should allows rewinds.
java.lang.String	getDescription() Returns the description.
java.lang.String	getExpectedContentType() Returns the expected content type.
java.lang.String	getFileref() Returns the SAS fileref name.
java.lang.String	getLabel() Returns the label.
com.sas.storage.editableproperties.PropertyList	getLocalizableProperties()
boolean	isSource() True if this object is a data source; false if it's a data target.
void	setLocalizableProperties(com.sas.storage.editableproperties.PropertyMap map)
java.lang.String	toString() Returns the fileref name.

Field Detail

_streamElement

protected final transient org.w3c.dom.Element _streamElement

Method Detail

getFileref

public java.lang.String getFileref()

Returns the SAS fileref name.

Returns:

the fileref name

getLabel

public java.lang.String getLabel()

Returns the label.

Returns:

the label

getExpectedContentType

public java.lang.String getExpectedContentType()

Returns the expected content type.

Returns:

the expected content type

allowsRewinds

public boolean allowsRewinds()
                      throws java.lang.IllegalStateException

Determines whether the stream should allows rewinds. If true, it does; if false, it does not. This method should only be called for data sources.

Returns:

whether the stream allows rewinds

Throws:

java.lang.IllegalStateException - if called on a data target

getDescription

public java.lang.String getDescription()

Returns the description.

Returns:

the description

toString

public java.lang.String toString()

Returns the fileref name. This enables a GenericStream to be used as the parameter to ExecutionBaseInterface.getInputStream(Object) or ExecutionBaseInterface.getOutputStream(Object).

Overrides:

toString in class java.lang.Object

isSource

public boolean isSource()

True if this object is a data source; false if it's a data target.

getLocalizableProperties

public com.sas.storage.editableproperties.PropertyList getLocalizableProperties()

Specified by:

getLocalizableProperties in interface com.sas.storage.editableproperties.LocalizableProperties

setLocalizableProperties

public void setLocalizableProperties(com.sas.storage.editableproperties.PropertyMap map)

Specified by:

setLocalizableProperties in interface com.sas.storage.editableproperties.LocalizableProperties

*** This class provides Binary Compatibility only, not Source Compatibility ***