de.aristaflow.adept2.model.datamanagement

Interface UDTValue

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ADEPT2UDTValue, FileUDTValue

public interface UDTValue
extends java.io.Serializable

This interface encapsulates the value of a user-defined data type (UDT). A UDT is not understood by ADEPT2. Instead, the application reading or writing a UDTValue needs to understand it. Besides, user-defined functions (UDFs) can be registered, that are able to interpret the data type and return data types understood by ADEPT2.

Since UDTs are treated as black boxes, they are provided by InputStreams. This resembles BLOBs in database-management-systems.

To avoid serialisation problems do not implement this interface! Use ADEPT2UDTValue instead!

Author:

Ulrich Kreher

See Also:

Blob

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID Generated ID for serialisation.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getUserDefinedType() Gets the name (a string) of the user-defined type of this value.
byte[]	getValueAsArray() Gets the value as a byte array of this user-defined data type.
java.io.InputStream	getValueAsStream() Gets the value as an InputStream of this user-defined data type.

Field Detail

serialVersionUID

static final long serialVersionUID

Generated ID for serialisation.

See Also:

Constant Field Values

Method Detail

getUserDefinedType

java.lang.String getUserDefinedType()

Gets the name (a string) of the user-defined type of this value.

Returns:

The name of the user-defined data type of this value.

getValueAsStream

java.io.InputStream getValueAsStream()

Gets the value as an InputStream of this user-defined data type.

Returns:

The value of a (this) user-defined data type as an InputStream.

getValueAsArray

byte[] getValueAsArray()

Gets the value as a byte array of this user-defined data type.

Returns:

The value of a (this) user-defined data type as an array of bytes.