## Uses of Class
com.streambase.sb.Schema.Field

- Packages that use Schema.Field
  Package | Description
  --- | ---
  com.streambase.liveview.client | Provides classes and interfaces fundamental to the TIBCO Live Datamart Java API.
  com.streambase.sb | Provides classes and interfaces fundamental to the TIBCO StreamBase Java API.
  com.streambase.sb.client | Provides classes and interfaces used to communicate with a StreamBase server.
  com.streambase.sb.operator | Provides classes and interfaces to add custom operators to StreamBase applications.

- - ### Uses of Schema.Field in com.streambase.liveview.client

    Methods in com.streambase.liveview.client that return types with arguments of type Schema.Field
    Modifier and Type | Method and Description
    --- | ---
    `List<Schema.Field>` | TupleUpdatedEvent.`getChangedFields()` Retrieve a list of the fields that changed in this update
    `List<Schema.Field>` | AbstractTable.`getFields()`
    `List<Schema.Field>` | BeginDeleteEvent.`getFields()` Get the list of fields that the query tuples will have
    `List<Schema.Field>` | BeginSnapshotEvent.`getFields()` Get the list of fields that the query tuples will have
    `List<Schema.Field>` | DeleteQueryListener.`getFields()` Retrieves the fields describing the tuples that will be returned.
    `List<Schema.Field>` | Query.`getFields()` Returns a list describing the fields of the tuples that will be returned by this Query.
    `List<Schema.Field>` | QueryConfig.`getFields()` Get the fields or null if not specified
    `List<Schema.Field>` | QueryListenerWrapper.`getFields()`
    `List<Schema.Field>` | SnapshotQueryListener.`getFields()` Retrieves the fields describing the tuples that will be returned.
    `List<Schema.Field>` | SnapshotResult.`getFields()` Retrieves the fields describing the tuples that will be returned.
    `List<Schema.Field>` | Table.`getFields()` Returns the fields describing the table columns.
    `List<Schema.Field>` | AbstractTable.`getFields(boolean includeInternal)`
    `List<Schema.Field>` | Table.`getFields(boolean includeInternal)` Returns the fields describing the table columns.
    `List<Schema.Field>` | AbstractTable.`getKeyFields()`
    `List<Schema.Field>` | Query.`getKeyFields()` Returns a list of fields describing the primary key for this table.
    `List<Schema.Field>` | QueryListenerWrapper.`getKeyFields()`
    `List<Schema.Field>` | Table.`getKeyFields()` Returns the schema which describes the key for the records in this table.

    Methods in com.streambase.liveview.client with parameters of type Schema.Field
    Modifier and Type | Method and Description
    --- | ---
    `QueryConfig` | QueryConfig.`setSelectFields(Schema.Field... fields)` Configure the result fields

    Method parameters in com.streambase.liveview.client with type arguments of type Schema.Field
    Modifier and Type | Method and Description
    --- | ---
    `QueryConfig` | QueryConfig.`setQuery(List<Schema.Field> fields, String table, String predicate)` Configure the table to query, the predicate and the result fields
    `QueryConfig` | QueryConfig.`setQuery(List<Schema.Field> fields, String table, String predicate, int limit)` Configure the table to query, the predicate and the result fields using a specified row limit
    `QueryConfig` | QueryConfig.`setQuery(List<Schema.Field> fields, String table, String predicate, int limit, long timePredicateInMillis)` Configure the table to query, the predicate and the result fields using a specified row limit and row delay
    `QueryConfig` | QueryConfig.`setSelectFields(List<Schema.Field> fields)` Configure the result fields

    Constructor parameters in com.streambase.liveview.client with type arguments of type Schema.Field
    Constructor and Description
    `BeginDeleteEvent(Object source, List<Schema.Field> fields)`
    `BeginSnapshotEvent(Object source, List<Schema.Field> fields)`
    `TupleUpdatedEvent(Object source, Long key, Tuple oldTuple, Tuple newTuple, List<Schema.Field> changedFields)` Deprecated.
    `TupleUpdatedEvent(Object source, Long oldKey, Tuple oldTuple, Tuple newTuple, Tuple keyData, List<Schema.Field> changedFields, List<TupleFieldComparator> fieldComparators)`

  - ### Uses of Schema.Field in com.streambase.sb

    Methods in com.streambase.sb that return Schema.Field
    Modifier and Type | Method and Description
    --- | ---
    `static Schema.Field` | Schema.`createField(DataType type, String name)` Creates a new Field of the given DataType, with the given name.
    `static Schema.Field` | Schema.`createFunctionField(String fieldName, Schema argumentSchema, CompleteDataType returnType)` Creates a new Field of type FUNCTION, with the given name, argument list and return type.
    `static Schema.Field` | Schema.`createListField(String name, CompleteDataType elementType)` Creates a new Field of type LIST, with the given name and given element type
    `static Schema.Field` | Schema.`createTupleField(String name, Schema schema)` Creates a new Field of type TUPLE, with the given name and given schema
    `Schema.Field` | Schema.`getField(int fieldIndex)` Return a Field object at the given index within the schema
    `Schema.Field` | Schema.`getField(String fieldPathName)` Return a Field object with the given field pathname in or under this schema.
    `Schema.Field[]` | Schema.`getFields()` Return an array of Field objects corresponding to the fields in the schema.
    `Schema.Field` | Schema.Field.`getNestedField(String fieldPathName)` Return a field that identifies a field in a nested tuple field.
    `Schema.Field[]` | Schema.Field.`getNestedFields()` Return an array of fields, each of which identifies a field in a nested tuple field.
    `(package private) Schema.Field` | Schema.Field.`toPathlessField()` Return a Field like this Field except with any field path stripped out.

    Methods in com.streambase.sb that return types with arguments of type Schema.Field
    Modifier and Type | Method and Description
    --- | ---
    `List<Schema.Field>` | Schema.`fields()` Return a List of the Fields in this Schema
    `(package private) List<Schema.Field>` | Schema.Field.`getFieldPath()` Returns a list of Field's for navigating from this field's containing schema to the subtuple containing this field.
    `Iterator<Schema.Field>` | Schema.`iterator()`

    Methods in com.streambase.sb with parameters of type Schema.Field
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | Tuple.`checkType(Schema.Field resolvedField, DataType dataType)` Check type
    `protected int` | Tuple.`checkTypeAndNonNull(Schema.Field resolvedField, DataType dataType)` check the type and make sure it is non null
    `void` | Tuple.`copyField(Schema.Field sourceField, Tuple destTuple, Schema.Field destField)` Copy the field from this tuple to the destination tuple
    `boolean` | Schema.Field.`equalsNoCapture(Schema.Field other)`
    `Tuple` | Tuple.`getAllocatedTuple(Schema.Field field)` Return a reference (not a copy) to the specified nested tuple field.
    `ByteArrayView` | Tuple.`getBlobBuffer(Schema.Field field)` Return a ByteArrayView for a given blob field.
    `boolean` | Tuple.`getBoolean(Schema.Field field)` Return the value of a specified boolean field.
    `Tuple` | Tuple.`getCapture(Schema.Field field)` Return the value of the named capture field.
    `protected abstract Tuple` | Tuple.`getCaptureImpl(Schema.Field field)` Get capture field
    `double` | Tuple.`getDouble(Schema.Field field)` Return the value of a specified double field.
    `Object` | Tuple.`getField(Schema.Field field)` Return the value of a specified field.
    `String` | Tuple.`getFieldAsString(Schema.Field field, Tuple.TupleFormatter formatter)` Get the current field as a human readable string, using the `Tuple.TupleFormatter` provided.
    `int` | TupleUtil.RepMethods.`getFieldLength(Tuple tuple, Schema.Field field)`
    `Function` | Tuple.`getFunction(Schema.Field field)` Return the value of the given function field.
    `int` | Tuple.`getInt(Schema.Field field)` Return the value of a specified int field.
    `List<?>` | Tuple.`getList(Schema.Field field)` Return the value of a specified list field.
    `long` | Tuple.`getLong(Schema.Field field)` Return the value of a specified long field.
    `String` | Tuple.`getString(Schema.Field field)` Return the value of a specified string field.
    `Timestamp` | Tuple.`getTimestamp(Schema.Field field)` Return the value of a specified timestamp field.
    `Tuple` | Tuple.`getTuple(Schema.Field field)` Return a reference (not a copy) to the specified nested tuple field.
    `boolean` | Tuple.`isNull(Schema.Field field)` Determines whether the given field's value in this Tuple is null.
    `(package private) abstract void` | TupleUtil.RepMethods.`serializeField(TupleRep tuple, Schema.Field field, ByteOrderedDataOutput out)`
    `void` | Tuple.`setBlobBuffer(Schema.Field field, ByteArrayView value)` Set a specified blob field to a copy of a specified blob.
    `void` | Tuple.`setBoolean(Schema.Field field, boolean value)` Set a named boolean field to a specified value.
    `void` | Tuple.`setCapture(Schema.Field field, Tuple value)` Set a specified capture field to a copy of a specified tuple.
    `void` | Tuple.`setDouble(Schema.Field field, double value)` Set a named double field to a specified value.
    `void` | Tuple.`setField(Schema.Field field, Object value)` Set a specified field to a specified boxed value.
    `void` | Tuple.`setField(Schema.Field field, Object value, CSV.FormatInfo format)` Set the field at a specified field name to a specified boxed value.
    `void` | Tuple.`setFunction(Schema.Field field, Function value)` Set a specified function field to the given `Function`
    `void` | Tuple.`setInt(Schema.Field field, int value)` Set a specified int field to a specified value.
    `void` | Tuple.`setList(Schema.Field field, List<?> value)` Set a specified list field to a copy of a specified value.
    `void` | Tuple.`setLong(Schema.Field field, long value)` Set a specified long field to a specified value.
    `void` | Tuple.`setNull(Schema.Field field)` Set the specified field to null
    `void` | Tuple.`setString(Schema.Field field, CharSequence value)` Set a specified string field to a specified value.
    `void` | Tuple.`setTimestamp(Schema.Field field, Timestamp value)` Set a named timestamp field to a specified value.
    `void` | Tuple.`setTuple(Schema.Field field, Tuple value)` Set a specified nested tuple field to that of the specified tuple NOTE: A copy of the the tuple may be made to convert the given tuple to the appropriate internal representation.
    `void` | SchemaUtil.SchemaTraversal.`visitField(Schema.Field field, String fieldPath)` This method will be called for each and every field in the schema, including nested fields and fields in lists of tuples

    Constructors in com.streambase.sb with parameters of type Schema.Field
    Constructor and Description
    `Field(Schema.Field field)` Construct a Field from an existing Field.
    `Field(String name, Schema.Field field)` Construct a Field from an existing Field, giving the new field a specified name
    `Schema(String name, Schema.Field... fields)` Construct a Schema out of a list of `Schema.Field`
    `Schema(String name, String description, Schema.Field... fields)` Construct a Schema out of a list of `Schema.Field`

    Constructor parameters in com.streambase.sb with type arguments of type Schema.Field
    Constructor and Description
    `Schema(String name, List<Schema.Field> fields)` Create a new schema from a list of `Schema.Field`

  - ### Uses of Schema.Field in com.streambase.sb.client

    Methods in com.streambase.sb.client that return Schema.Field
    Modifier and Type | Method and Description
    --- | ---
    `Schema.Field` | HAAdmin.`getDynamicVariableField(long timeoutMS, Path dynamicVariablePath)`

  - ### Uses of Schema.Field in com.streambase.sb.operator

    Methods in com.streambase.sb.operator that return types with arguments of type Schema.Field
    Modifier and Type | Method and Description
    --- | ---
    `List<Schema.Field>` | TableAccessor.`getPrimaryKeyFields()` The fields from the schema which make up the primary key.

Copyright © 2015–2018 Cloud Software Group, Inc.. All rights reserved.