Uses of Class
com.streambase.sb.Schema

Packages that use Schema

Package	Description
com.streambase.liveview.client	Provides classes and interfaces fundamental to the LiveView Java API.
com.streambase.liveview.client.dynamictables	Provides classes to configure table options.
com.streambase.sb	Provides classes and interfaces fundamental to the Streaming Java API.
com.streambase.sb.client	Provides classes and interfaces used to communicate with a Streaming 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 Streaming server.
com.streambase.sb.operator	Provides classes and interfaces to add custom operators to Streaming 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 Streaming Unit tests.

Uses of Schema in com.streambase.liveview.client

Methods in com.streambase.liveview.client that return Schema

Modifier and Type	Method	Description
Schema	SendTupleInfo.getResponseOutputSchema()
Schema	QueryListenerWrapper.getSchema()	Getter for the Schema for the query.
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	Description
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.
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.
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)	Setter for the Schema for the query.

Constructors in com.streambase.liveview.client with parameters of type Schema

Modifier	Constructor	Description
	AbstractTable(Schema schema, String keyFieldNamesCSV)
	AbstractTable(Schema schema, List<String> keyFieldNames)
	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	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	Description
static final Schema	Schema.EMPTY_SCHEMA	An empty schema
static Schema	SchemaUtil.EMPTY_SCHEMA	An empty schema
static final Schema	ControlStream.SCHEMA	Control stream schema

Fields in com.streambase.sb with type parameters of type Schema

Modifier and Type	Field	Description
static final ConcurrentMap<Schema,String>	SchemaUtil.NULL_VALUE_EXPR_BY_SCHEMA	Null value expression cache

Methods in com.streambase.sb that return Schema

Modifier and Type	Method	Description
static Schema	SchemaUtil.addFields(Schema base, Schema.Field... additionalFields)	Create a new schema augmenting the fields in the base schema with additional fields
static Schema	SchemaUtil.addFields(Schema base, String newName, Schema.Field... additionalFields)	Create a new schema augmenting the fields in the base schema with additional fields
Schema	OutputSchemaBuilder.buildResultSchema()	Build result schema
static Schema	SchemaUtil.computeOutputSchema(com.streambase.sb.util.LocatedItem loc, Schema[] schemas, Set<SchemaUtil.CoercionOptions> options, com.streambase.sb.internal.CapturedSchemas capturedSchemas, String errorPrefix)	Compute output schema
static Schema	SchemaUtil.createSchema(String name, Schema definedHere, List<Schema> parentSchemas, com.streambase.sb.util.Location loc)	Create a new schema with the given parent schemas and the given fields defined here.
static Schema	SchemaUtil.createSchema(String name, Schema definedHere, List<Schema> parentSchemas, com.streambase.sb.util.Location loc, List<StreamBaseException> storeExceptions)	Create a new schema with the given parent schemas and the given fields defined here.
static Schema	SchemaUtil.createSchema(String name, Schema definedHere, List<String> parentSchemaNames, SchemaUtil.SchemaProvider provider, com.streambase.sb.util.Location loc, List<StreamBaseException> storeExceptions)	Create a new schema with the given parent schema names and the given fields defined here.
static Schema	SchemaUtil.createSchema(Element element, ByteOrder ord, SchemaUtil.SchemaProvider schemaProvider, List<StreamBaseException> errors)	Create a schema from XML
static Schema	SchemaUtil.determineResultSchema(Schema res, Schema[] options)	Select the correct result schema for this field mapper.
static Schema	SchemaUtil.expandCaptureFields(com.streambase.sb.util.LocatedItem loc, Schema schema, Set<SchemaUtil.CoercionOptions> options, com.streambase.sb.internal.CapturedSchemas capturedSchemas)	Take a schema which might have capture field, and expand the field.
Schema	SchemaMismatchException.getActualSchema()
Schema	BasicFunction.getArgumentSchema()
Schema	CompleteDataType.FunctionType.getArgumentSchema()
Schema	CompleteDataType.getArgumentSchema()	For function types, return the argument schema.
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.
static Schema	SchemaUtil.getSchema(CompleteDataType cdt)	Get schema for complete data type
static Schema	SchemaUtil.getSchema(Schema.Field f)	Get schema for a schema field
Schema	StreamProperties.getSchema()	Return the stream's Schema
final Schema	Tuple.getSchema()	Return the Schema for this Tuple
Schema	SchemaUtil.SchemaProvider.getSchemaByHash(byte[] hash)	request a schema by hash
static Schema	SBUtils.newSchema(String xmlString, boolean hasHeader, ByteOrder order)	Deprecated. please use SBUtils.newSchema(String, ByteOrder)
static Schema	SBUtils.newSchema(String xmlString, ByteOrder order)	Create a new schema
static Schema	SBUtils.newSchema(String name, List<Schema.Field> fields, boolean hasHeader, ByteOrder order)	Deprecated. please use SBUtils.newSchema(String, List, ByteOrder)
static Schema	SBUtils.newSchema(String name, List<Schema.Field> fields, ByteOrder order)	Create a new schema
static Schema	SBUtils.newSchema(Element element, boolean hasHeader, ByteOrder order)	Deprecated. please use SBUtils.newSchema(Element, ByteOrder)
static Schema	SBUtils.newSchema(Element element, ByteOrder order)	Create a new schema
static Schema	SchemaUtil.removeFields(Schema base, String... fieldNames)	Remove the fields by name from the schema.
static Schema	SchemaUtil.sanitizeFieldNames(Schema origSchema)	Sanitize field names so that they are generic

Methods in com.streambase.sb that return types with arguments of type Schema

Modifier and Type	Method	Description
List<Schema>	Schema.getParentSchemas()
static List<Schema>	SchemaUtil.getSchemasFromNames(List<String> names, SchemaUtil.SchemaProvider schemaProvider)	Given a schema provider, get all the schemas for the given schema names
static Map<byte[],Schema>	SchemaUtil.newSchemaMap()	create a Map<> with the approbate comparator for schemas

Methods in com.streambase.sb with parameters of type Schema

Modifier and Type	Method	Description
static Schema	SchemaUtil.addFields(Schema base, Schema.Field... additionalFields)	Create a new schema augmenting the fields in the base schema with additional fields
static Schema	SchemaUtil.addFields(Schema base, String newName, Schema.Field... additionalFields)	Create a new schema augmenting the fields in the base schema with additional fields
static String	AbstractFunction.buildFunctionRep(String name, Schema argSchema, String returnType, String body)	Build function
static byte[]	SchemaUtil.buildHash(Schema schema, boolean includeFieldNames)	Build hash for schema
static Schema	SchemaUtil.computeOutputSchema(com.streambase.sb.util.LocatedItem loc, Schema[] schemas, Set<SchemaUtil.CoercionOptions> options, com.streambase.sb.internal.CapturedSchemas capturedSchemas, String errorPrefix)	Compute output schema
static void	SchemaUtil.copyAllDescriptionsForEquivalentFields(Schema source, Schema target)	For all fields in source, when they are present in target, descriptions are copied.
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	SchemaUtil.createSchema(String name, Schema definedHere, List<Schema> parentSchemas, com.streambase.sb.util.Location loc)	Create a new schema with the given parent schemas and the given fields defined here.
static Schema	SchemaUtil.createSchema(String name, Schema definedHere, List<Schema> parentSchemas, com.streambase.sb.util.Location loc, List<StreamBaseException> storeExceptions)	Create a new schema with the given parent schemas and the given fields defined here.
static Schema	SchemaUtil.createSchema(String name, Schema definedHere, List<String> parentSchemaNames, SchemaUtil.SchemaProvider provider, com.streambase.sb.util.Location loc, List<StreamBaseException> storeExceptions)	Create a new schema with the given parent schema names and the given fields defined here.
static Schema.Field	Schema.createTupleField(String name, Schema schema)	Creates a new Field of type TUPLE, with the given name and given schema
static Element	SchemaUtil.createXmlElement(Schema schema, SchemaUtil.SchemaProvider schemaProvider, EnumSet<SchemaUtil.CopyOptions> options)	Create and return the XML for the specified schema.
static Element	SchemaUtil.createXmlElement(Schema schema, Document document, SchemaUtil.SchemaProvider schemaProvider)	Create and return the XML for the specified schema.
static Element	SchemaUtil.createXmlElement(Schema schema, Document document, SchemaUtil.SchemaProvider schemaProvider, EnumSet<SchemaUtil.CopyOptions> options)	Create and return the XML for the specified schema.
static Element	SchemaUtil.createXmlElement(Schema schema, Node parent, SchemaUtil.SchemaProvider schemaProvider, EnumSet<SchemaUtil.CopyOptions> options)	Create and return the XML for the specified schema and add the XML as a child of the specified parent.
static Schema	SchemaUtil.determineResultSchema(Schema res, Schema[] options)	Select the correct result schema for this field mapper.
boolean	Schema.equalsNoCapture(Schema scm)	Compare schemas without capture fields
static Schema	SchemaUtil.expandCaptureFields(com.streambase.sb.util.LocatedItem loc, Schema schema, Set<SchemaUtil.CoercionOptions> options, com.streambase.sb.internal.CapturedSchemas capturedSchemas)	Take a schema which might have capture field, and expand the field.
static List<String>	SchemaUtil.findCaptures(Schema s)	Find all capture fields in schema
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.
static int	SchemaUtil.getApproximateSize(Schema schema)	Calculates an estimate (does not account for variable-sized types) for the size of a tuple with this schema, including the header and null mask.
static byte[]	SchemaUtil.getFieldTypeHash(Schema schema)	Get field type hash
static List<String>	SchemaUtil.getParentSchemaNames(Schema schema)	Get the names of the parent schemas for the given schema
static boolean	SchemaUtil.hasCapture(Schema s)	Does schema have a capture field?
static boolean	SchemaUtil.hasMultiCapture(Schema s)	Does schema have multiple capture fields?
void	OutputSchemaBuilder.includeSchema(int schemaIndex, Schema schema)	Include 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.
static Schema	SchemaUtil.removeFields(Schema base, String... fieldNames)	Remove the fields by name from the schema.
void	ReadOnlyTupleRep.reset(Schema newSchema, byte[] data, int offset, com.streambase.sb.util.ByteArrayUtils bau)	reset this tuple with new data...
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.
static boolean	SchemaUtil.sameFieldsIgnoreOrder(Schema one, Schema two)	Note: if you call this, and are thinking of throwing an exception when things don't match...
static boolean	SchemaUtil.sameFieldsIncludingDescriptions(Schema one, Schema two)	Note: if you call this, and are thinking of throwing an exception when things don't match...
boolean	Schema.sameFieldTypes(Schema other)	Returns true if this schema has the same field types in the same order as another Schema
static Schema	SchemaUtil.sanitizeFieldNames(Schema origSchema)	Sanitize field names so that they are generic
void	SchemaUtil.SchemaTraversal.visitSchema(Schema schema, String fieldPath)	This method will be called for each and every schema

Method parameters in com.streambase.sb with type arguments of type Schema

Modifier and Type	Method	Description
static Schema	SchemaUtil.createSchema(String name, Schema definedHere, List<Schema> parentSchemas, com.streambase.sb.util.Location loc)	Create a new schema with the given parent schemas and the given fields defined here.
static Schema	SchemaUtil.createSchema(String name, Schema definedHere, List<Schema> parentSchemas, com.streambase.sb.util.Location loc, List<StreamBaseException> storeExceptions)	Create a new schema with the given parent schemas and the given fields defined here.

Constructors in com.streambase.sb with parameters of type Schema

Modifier	Constructor	Description
protected	CompiledTuple(Schema schema)	Constructor
	Field(String name, DataType dataType, Schema s)	Deprecated. Use Field(String, CompleteDataType) instead with new Schema(name, CompleteDataType.forTuple(s)), or createTupleField(String, Schema)
	FunctionType(Schema arguments, CompleteDataType returnType)	Constructor
	ReadOnlyCompositeTuple(Schema compositeSchema, Schema... baseSchemas)	Create a Tuple with the given compositeSchema.
	ReadOnlyCompositeTuple(Schema compositeSchema, Tuple... tuples)	Create a Tuple with the given compositeSchema.
protected	ReadOnlyTuple(Schema schema)	Construtor
	ReadOnlyTupleByIndexWrapper(Schema derived, Tuple baseTuple)	Create a Tuple Wrapper
	ReadOnlyTupleRep(Schema schema, byte[] data, int offset, com.streambase.sb.util.ByteArrayUtils bau)	Create a ReadOnlyTupleRep from a serialized tuple
	ReadOnlyTupleRep(Schema schema, byte[] data, int offset, ByteOrder b)	Create a ReadOnlyTupleRep from a serialized tuple
	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(com.streambase.sb.util.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.
(package private)	TupleLayout(Schema schema)	Constructor
protected	TupleRep(Schema schema, com.streambase.sb.util.ByteArrayUtils bau, TupleRep.TupleLayout tupleLayout)	Constructor with tuple rep
	TupleType(Schema schema)	Constructor

Uses of Schema in com.streambase.sb.client

Methods in com.streambase.sb.client that return Schema

Modifier and Type	Method	Description
Schema	DequeueResult.getSchema()	Returns the schema for the tuples dequeued, may return null
Schema	Admin.getSchemaByHash(long timeoutMS, byte[] hash)	Return the Schema object for the given hash value
Schema	HAAdmin.getSchemaByHash(long timeoutMS, byte[] hash)
Schema	StreamBaseClient.getSchemaByHash(byte[] hash)	Return the Schema object for the given hash value
Schema	XmlRpcAdmin.getSchemaByHash(long timeoutMS, byte[] hash)
Schema	Admin.getSchemaByName(long timeoutMS, String schemaName)	Return the Schema object for the given name
Schema	HAAdmin.getSchemaByName(long timeoutMS, String schemaName)
Schema	StreamBaseClient.getSchemaByName(String name)	Return the Schema object for the given name.
Schema	XmlRpcAdmin.getSchemaByName(long timeoutMS, String schemaName)
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	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	Description
static final Schema	StreamBaseMonitor.STAT_SCHEMA	The stats schema.
static final Schema	StreamBaseMonitor.STAT_SCHEMA_V3	The v3 stats schema.

Methods in com.streambase.sb.monitor that return Schema

Modifier and Type	Method	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	Description
Schema	Operator.getDynamicVariablesSchema()	Retrieves a Schema containing information about every dynamic variable available to the module this operator is contained in.
final Schema	Operator.getInputSchema(int port)	Returns the schema of an input port.
Schema	Operator.getNamedSchema(String name)
final 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.
final Schema	Operator.getRuntimeInputSchema(int port)	Returns the schema of an input port at runtime.
final 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.
final Schema	Operator.getTypecheckInputSchema(int port)	Returns the schema of an input port that was set at application typecheck time.
final Schema	Operator.getTypecheckOutputSchema(int outputPort)	Return the output schema as set by typecheck.
final 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	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
PreparedQuery	TableAccessor.prepare(String predicate, Schema args)	Prepare an index-accessing query.
final 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	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	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	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	Description
abstract Tuple	AbstractTupleMaker.createTuple(Schema schema, T t)
Tuple	CSVTupleMaker.createTuple(Schema schema, String str)
Tuple	JSONSingleQuotesTupleMaker.createTuple(Schema schema, String str)
Tuple	JSONTupleMaker.createTuple(Schema schema, String str)
Tuple	ObjectArrayTupleMaker.createTuple(Schema schema, Object[] objs)
Tuple	TupleMaker.createTuple(Schema schema, T t)	create a Tuples from an input object
List<Tuple>	AbstractTupleMaker.createTuples(Schema schema, Collection<T> ts)
List<Tuple>	AbstractTupleMaker.createTuples(Schema schema, T... ts)
List<Tuple>	TupleMaker.createTuples(Schema schema, Collection<T> t)	create multiple Tuples from input objects
List<Tuple>	TupleMaker.createTuples(Schema schema, T... t)	create multiple Tuples from input objects