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

- Packages that use Schema
  Package | Description
  --- | ---
  com.streambase.liveview.client | Provides classes and interfaces fundamental to the TIBCO Live Datamart Java API.
  com.streambase.liveview.client.dynamictables | Provides classes to configure table options.
  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.feedsim | Provides abstract classes to extend feedsim input sources.
  com.streambase.sb.monitor | Provides classes and interfaces to monitor the behavior of a running StreamBase server.
  com.streambase.sb.operator | Provides classes and interfaces to add custom operators to StreamBase applications.
  com.streambase.sb.operator.parameter | Provides classes and interfaces to specify parameters for custom operators.
  com.streambase.sb.unittest | Provides classes and interfaces used to author StreamBase Unit tests.

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

    Methods in com.streambase.liveview.client that return Schema
    Modifier and Type | Method and Description
    --- | ---
    `Schema` | SendTupleInfo.`getResponseOutputSchema()`
    `Schema` | QueryListenerWrapper.`getSchema()`
    `Schema` | TablePublisher.`getSchema()` Schema needed to create tuples for the publish method.
    `Schema` | SendTupleInfo.`getTargetInputSchema()`

    Methods in com.streambase.liveview.client with parameters of type Schema
    Modifier and Type | Method and Description
    --- | ---
    `void` | TableAdminManager.`createTable(String tableName, String description, Schema schema, List<List<String>> indices)` Create a table on the server without any LVConf which represents it.
    `void` | TableAdminManager.`createTable(String tableName, String description, Schema schema, String... primaryKeyFields)` Convenience form of the previous method, used if there is only a primary key.
    `Tuple` | LiveViewConnection.`sendTupleAction(StreamBaseURI sbUri, String targetInputStreamName, Tuple tuple, String responseOutputStreamName, Schema expectedResponseSchema, long timeout, TimeUnit unit)` Sends a tuple to an existing StreamBase application.
    `void` | QueryListenerWrapper.`setSchema(Schema schema)`

    Constructors in com.streambase.liveview.client with parameters of type Schema
    Constructor and Description
    `AbstractTable(Schema schema, List<String> keyFieldNames)`
    `AbstractTable(Schema schema, String keyFieldNamesCSV)`
    `SendTupleInfo(StreamBaseURI sbUri, String inputStreamName, String outputStreamName, Schema inputSchema, Schema outputSchema)`

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

    Methods in com.streambase.liveview.client.dynamictables with parameters of type Schema
    Modifier and Type | Method and Description
    --- | ---
    `TableConfig` | TableConfig.`setSchema(Schema sbSchema)` This method is used to set the schema for the table being configured.

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

    Fields in com.streambase.sb declared as Schema
    Modifier and Type | Field and Description
    --- | ---
    `static Schema` | Schema.`EMPTY_SCHEMA` An empty schema

    Methods in com.streambase.sb that return Schema
    Modifier and Type | Method and Description
    --- | ---
    `Schema` | OutputSchemaBuilder.`buildResultSchema()`
    `Schema` | SchemaMismatchException.`getActualSchema()`
    `Schema` | CompleteDataType.`getArgumentSchema()` For function types, return the argument schema.
    `Schema` | CompleteDataType.FunctionType.`getArgumentSchema()`
    `Schema` | Function.`getArgumentSchema()` Returns Schema for the input argument types of the function.
    `Schema` | TupleCaptureTransformer.`getCollapsedSchema()`
    `(package private) Schema` | Schema.Field.`getContainingSchema()` Returns the schema of which this field is a part.
    `static Schema` | Schema.`getErrorSchema()`
    `Schema` | TupleCaptureTransformer.`getExpandedSchema()`
    `Schema` | SchemaMismatchException.`getExpectedSchema()`
    `Schema` | Schema.`getLocallyDefinedFields()`
    `Schema` | SchemaUtil.SchemaProvider.`getNamedSchema(String name)` A request to provide a Schema for the given name.
    `Schema` | CompleteDataType.`getSchema()` For tuple types, return the tuple's schema.
    `Schema` | CompleteDataType.TupleType.`getSchema()`
    `Schema` | Schema.Field.`getSchema()` Return the schema for this field.
    `Schema` | StreamProperties.`getSchema()` Return the stream's Schema
    `Schema` | Tuple.`getSchema()` Return the Schema for this Tuple
    `Schema` | SchemaUtil.SchemaProvider.`getSchemaByHash(byte[] hash)` request a schema by hash

    Methods in com.streambase.sb that return types with arguments of type Schema
    Modifier and Type | Method and Description
    --- | ---
    `List<Schema>` | Schema.`getParentSchemas()`

    Methods in com.streambase.sb with parameters of type Schema
    Modifier and Type | Method and Description
    --- | ---
    `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.`createTupleField(String name, Schema schema)` Creates a new Field of type TUPLE, with the given name and given schema
    `boolean` | Schema.`equalsNoCapture(Schema scm)`
    `static CompleteDataType.FunctionType` | CompleteDataType.`forFunction(Schema argumentSchema, CompleteDataType returnType)` Return a function's `CompleteDataType` with the given argument schema and return type
    `static CompleteDataType` | CompleteDataType.`forTuple(Schema schema)` Return a tuple complete data type with the specified schema.
    `void` | OutputSchemaBuilder.`includeSchema(int schemaIndex, Schema schema)`
    `boolean` | Schema.`isSubsetOf(Schema schema)` Returns true if this schema's fields are a subset of the supplied schema's fields Does not recursively test nested schemas for subsetness.
    `boolean` | Schema.`isSupersetOf(Schema schema)` Returns true if this schema's fields are a superset of the supplied schema's fields Does not recursively test nested schemas for subsetness.
    `void` | SchemaUtil.SchemaTraversal.`run(Schema schema, String path)` Run the schema visitor
    `boolean` | Schema.`sameFieldsAs(Schema other)` Returns true if this schema has the same field types and names in the same order as another Schema.
    `boolean` | Schema.`sameFieldTypes(Schema other)` Returns true if this schema has the same field types in the same order as another Schema
    `void` | SchemaUtil.SchemaTraversal.`visitSchema(Schema schema, String fieldPath)` This method will be called for each and every schema

    Constructors in com.streambase.sb with parameters of type Schema
    Constructor and Description
    `CompiledTuple(Schema schema)`
    `Field(String name, DataType dataType, Schema s)` Deprecated. Use `Schema.Field#Field(String, CompleteDataType)` instead with new Schema(name, CompleteDataType.forTuple(s)), or `Schema.createTupleField(String, Schema)`
    `FunctionType(Schema arguments, CompleteDataType returnType)`
    `Schema(Schema baseSchema)` Construct a Schema from another schema
    `Schema(String name, Schema baseSchema)` Construct a Schema with a new name from another schema
    `SchemaMismatchException(LocatedItem loc, String msg, Schema exp, Schema act)`
    `TupleCopier(Schema sourceSchema, Schema destSchema, boolean strict)` Create the TupleCopier.
    `TupleCopier(Schema sourceSchema, Schema destSchema, EnumSet<TupleCopier.Options> options)` Create the TupleCopier.
    `TupleType(Schema schema)`

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

    Methods in com.streambase.sb.client that return Schema
    Modifier and Type | Method and Description
    --- | ---
    `Schema` | DequeueResult.`getSchema()` Returns the schema for the tuples dequeued, may return null
    `Schema` | StreamBaseClient.`getSchemaByHash(byte[] hash)` Return the Schema object for the given hash value
    `Schema` | Admin.`getSchemaByHash(long timeoutMS, byte[] hash)` Return the Schema object for the given hash value
    `Schema` | HAAdmin.`getSchemaByHash(long timeoutMS, byte[] hash)` Return the Schema object for the given hash value
    `Schema` | Admin.`getSchemaByName(long timeoutMS, String schemaName)` Return the Schema object for the given name
    `Schema` | HAAdmin.`getSchemaByName(long timeoutMS, String schemaName)` Return the Schema object for the given name
    `Schema` | StreamBaseClient.`getSchemaByName(String name)` Return the Schema object for the given name.
    `Schema` | StreamBaseClient.`getSchemaForStream(String streamName)` Return the schema of a stream.

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

    Methods in com.streambase.sb.feedsim that return Schema
    Modifier and Type | Method and Description
    --- | ---
    `abstract Schema` | FeedSimTupleInputStream.`getSchema()` This method must return the Schema of the data to be returned by readTuple()

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

    Fields in com.streambase.sb.monitor declared as Schema
    Modifier and Type | Field and Description
    --- | ---
    `static Schema` | StreamBaseMonitor.`STAT_SCHEMA` The stats schema.
    `static Schema` | StreamBaseMonitor.`STAT_SCHEMA_V3` The v3 stats schema.

    Methods in com.streambase.sb.monitor that return Schema
    Modifier and Type | Method and Description
    --- | ---
    `Schema` | StreamBaseMonitor.`getStatsSchema()` Get the stats schema

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

    Methods in com.streambase.sb.operator that return Schema
    Modifier and Type | Method and Description
    --- | ---
    `Schema` | Operator.`getDynamicVariablesSchema()` Retrieves a Schema containing information about every dynamic variable available to the module this operator is contained in.
    `Schema` | Operator.`getInputSchema(int port)` Returns the schema of an input port.
    `Schema` | Operator.`getNamedSchema(String name)`
    `Schema` | Operator.`getOutputSchema(int outputPort)` Return the output schema for the given output port (zero-based).
    `Schema[]` | Operator.`getProposedInputSchemas(String mainName)` Override to provide schemas that Studio will offer to users to import into their projects.
    `Schema[]` | Operator.`getProposedOutputSchemas(String mainName)` Override to provide schemas that Studio will offer to users to import into their projects.
    `Schema` | Operator.`getRuntimeInputSchema(int port)` Returns the schema of an input port at runtime.
    `Schema` | Operator.`getRuntimeOutputSchema(int outputPort)` Return the output schema that should actually use to `Operator.sendOutput(int, Tuple)` or `Operator.sendOutputAsync(int, Tuple)`.
    `Schema` | TableAccessor.`getSchema()` The schema for rows in this table.
    `Schema` | Operator.`getSchemaForCapture(String captureName, int depth)` Finds the schema for the given capture name in the context that this operator is running under.
    `Schema` | Operator.`getTypecheckInputSchema(int port)` Returns the schema of an input port that was set at application typecheck time.
    `Schema` | Operator.`getTypecheckOutputSchema(int outputPort)` Return the output schema as set by typecheck.
    `Schema` | Operator.`setOutputSchema(int port, Schema outputSchema)` Sets the output schema for the given output port (port #'s are zero based).

    Methods in com.streambase.sb.operator with parameters of type Schema
    Modifier and Type | Method and Description
    --- | ---
    `TupleCaptureTransformer` | Operator.`getTupleCaptureTransformer(Schema s)` Get a TupleCaptureTransformer capable of translating tuples with the given schema to the equivalent schema with all the capture fields expanded out, and translating expanded tuples back into tuples with the given schema This method may only be called at runtime; the exact schemas of any capture fields are not fully determined at typecheck time.
    `PreparedQuery` | TableAccessor.`prepare(String predicate, Schema args)` Prepare an index-accessing query.
    `Schema` | Operator.`setOutputSchema(int port, Schema outputSchema)` Sets the output schema for the given output port (port #'s are zero based).

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

    Methods in com.streambase.sb.operator.parameter that return Schema
    Modifier and Type | Method and Description
    --- | ---
    `Schema[]` | StudioAssistSchemaFieldPicker.`getSchemasForFieldPicker(String propertyName, Schema[] inputSchemas)` Assists Studio in presenting a schema field picker to the user, for `String[]` property types with `UIHints` that have set `UIHints.setAssociateFieldPicker(boolean)` to `true`.

    Methods in com.streambase.sb.operator.parameter with parameters of type Schema
    Modifier and Type | Method and Description
    --- | ---
    `Schema[]` | StudioAssistSchemaFieldPicker.`getSchemasForFieldPicker(String propertyName, Schema[] inputSchemas)` Assists Studio in presenting a schema field picker to the user, for `String[]` property types with `UIHints` that have set `UIHints.setAssociateFieldPicker(boolean)` to `true`.

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

    Methods in com.streambase.sb.unittest that return Schema
    Modifier and Type | Method and Description
    --- | ---
    `Schema` | Dequeuer.`getSchema()` Get the `Schema` for the associated stream. Equivalent to `getStreamProperties().getSchema()`
    `Schema` | Enqueuer.`getSchema()` Get the `Schema` for the associated stream. Equivalent to `getStreamProperties().getSchema()`

    Methods in com.streambase.sb.unittest with parameters of type Schema
    Modifier and Type | Method and Description
    --- | ---
    `Tuple` | ObjectArrayTupleMaker.`createTuple(Schema schema, Object[] objs)`
    `Tuple` | CSVTupleMaker.`createTuple(Schema schema, String str)`
    `Tuple` | JSONSingleQuotesTupleMaker.`createTuple(Schema schema, String str)`
    `Tuple` | JSONTupleMaker.`createTuple(Schema schema, String str)`
    `abstract Tuple` | AbstractTupleMaker.`createTuple(Schema schema, T t)`
    `Tuple` | TupleMaker.`createTuple(Schema schema, T t)` create a `Tuple`s from an input object
    `List<Tuple>` | AbstractTupleMaker.`createTuples(Schema schema, Collection<T> ts)`
    `List<Tuple>` | TupleMaker.`createTuples(Schema schema, Collection<T> t)` create multiple `Tuple`s from input objects
    `List<Tuple>` | AbstractTupleMaker.`createTuples(Schema schema, T... ts)`
    `List<Tuple>` | TupleMaker.`createTuples(Schema schema, T... t)` create multiple `Tuple`s from input objects

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