Contains meta data about a Field in a Schema
Namespace: StreamBase.SBAssembly: StreamBase.SB.Client (in StreamBase.SB.Client.dll) Version: 10.2.0.0
Syntax
C# | Visual Basic | Visual C++ |
public class Field : ICloneable, IDisposable
Public Class Field _ Implements ICloneable, IDisposable
public ref class Field : ICloneable, IDisposable
Members
All Members | Properties ![]() | Methods ![]() |
![]() ![]() | ![]() ![]() ![]() | ![]() ![]() | ![]() ![]() ![]() ![]() |
Member | Description | |
---|---|---|
![]() | ArgumentSchema |
The argument schema for this field. Valid only if the field is of type FUNCTION. Otherwise the property returns null.
|
![]() | CheckType(CompleteDataType) |
Check to make sure that the given CompleteDataType is the same as the CompleteDataType of this Field
|
![]() | CheckType(DataType) | Obsolete.
Check to make sure that the given DataType is the same as the DataType of this Field
|
![]() | Clone()()()() |
Clone this Field
|
![]() | CompleteDataType |
The complete type of a field.
|
![]() | DataType |
The type of a field.
|
![]() | Description |
The description of this field.
|
![]() | ElementType |
The element type for this field. Valid only if the field is of type LIST. Otherwise the property returns null.
|
![]() | Equals(Object) |
Returns true if this Field is equivalent to the given one.
(Overrides Object..::..Equals(Object).) |
![]() | GetArgumentSchema()()()() |
The argument schema for this field. Valid only if the field is of type FUNCTION. Otherwise the property returns null.
|
![]() | GetCompleteDataType()()()() |
Returns the complete type of a field.
|
![]() | GetDataType()()()() |
Returns the type of a field.
|
![]() | GetDescription()()()() |
Returns the description of this field.
|
![]() | GetElementType()()()() |
The element type for this field. Valid only if the field is of type LIST. Otherwise the property returns null.
|
![]() | GetHashCode()()()() |
Hash function for this type.
(Overrides Object..::..GetHashCode()()()().) |
![]() | GetIndex()()()() |
Returns the index of the field
|
![]() | GetName()()()() |
Returns the name of the field.
|
![]() | GetNestedField(String) |
Return a field that identifies a field in a nested tuple field.
This method can be applied only to a field whose type is Tuple.
|
![]() | GetNestedFields()()()() |
Return an array of fields, each of which identifies a field in a nested tuple field.
This method can be applied only to a field whose type is Tuple.
|
![]() | GetReturnType()()()() |
The return type for this field. Valid only if the field is of type FUNCTION. Otherwise the property returns null.
|
![]() | GetSchema()()()() |
Returns the schema for this field. Valid only if the field is of type TUPLE. Otherwise null is returned.
|
![]() | GetShortName()()()() |
Returns the last (which might be the only) segment of this Field's name
|
![]() | GetSize()()()() |
Gets the size in bytes of this Field.
|
![]() | GetType()()()() | Gets the Type of the current instance. (Inherited from Object.) |
![]() | Index |
The index of the field.
|
![]() | Name |
The name of the field.
|
![]() | ReturnType |
The return type for this field. Valid only if the field is of type FUNCTION. Otherwise the property returns null.
|
![]() | SameType(Schema..::..Field) |
Return true if the fields are the same type (including
size information)
|
![]() | Schema |
The schema for this field. Valid only if the field is of type TUPLE. Otherwise the property returns null.
|
![]() | Size |
The size (in bytes) of the field.
|
![]() | ToString()()()() |
Returns a string representation of a field.
(Overrides Object..::..ToString()()()().) |
![]() | ToStringWithFields()()()() |
Returns a string representation of a field, showing schemas of Tuple fields
|