Skip navigation links
Spark CQL Extensibility Java API Reference for Oracle Stream Analytics
Release 18.1.0.0.1

E93123-02
A B C D E F G H I N O P S T V 

A

AdapterContext - Interface in com.oracle.cep.api.adapter
AdapterContext provides the contextual information to connectors and converters.
add(String, String, String) - Method in class com.oracle.cep.api.annotations.BaseMessageBundle
Add display name and description for a given key.
Attr - Interface in com.oracle.cep.api.event
Attr represents an attribute in an event.
AttrDataType - Enum in com.oracle.cep.api.event
AttrDataType is the data types for the attributes
AttrSpec - Interface in com.oracle.cep.api.event
EventSpec represents the specification(schema) of an attribute.

B

BaseMessageBundle - Class in com.oracle.cep.api.annotations
BaseMessageBundle is the helper class to define resource bundle for OSA plugins.
BaseMessageBundle() - Constructor for class com.oracle.cep.api.annotations.BaseMessageBundle
 
BatchEventProcessor - Interface in com.oracle.cep.api.stage
BatchEventProcessor represents the custom stage in Oracle Stream Analytics piepelines.
BigDecimalAttr(String) - Static method in class com.oracle.cep.api.event.TupleAttrSpec
 
BigDecimalAttr(String, int, int) - Static method in class com.oracle.cep.api.event.TupleAttrSpec
 
BigDecimalAttr(String, int, int, RoundingMode) - Static method in class com.oracle.cep.api.event.TupleAttrSpec
 
BigIntAttr(String) - Static method in class com.oracle.cep.api.event.TupleAttrSpec
 
BoolAttr(String) - Static method in class com.oracle.cep.api.event.TupleAttrSpec
 
BOOLEAN - Static variable in class com.oracle.cep.api.annotations.OsaConfigWidgetTypes
BOOLEAN widget type shows a checkbox representing flags

C

canHandleAcknowledges() - Method in interface com.oracle.cep.api.adapter.source.SourceConverter
Can pass through acknowledges from the reliable source connector?
close() - Method in interface com.oracle.cep.api.adapter.ContextAware
Callback method to close the adapter and any open resources.
com.oracle.cep.api.adapter - package com.oracle.cep.api.adapter
 
com.oracle.cep.api.adapter.sink - package com.oracle.cep.api.adapter.sink
 
com.oracle.cep.api.adapter.source - package com.oracle.cep.api.adapter.source
 
com.oracle.cep.api.annotations - package com.oracle.cep.api.annotations
 
com.oracle.cep.api.event - package com.oracle.cep.api.event
 
com.oracle.cep.api.exceptions - package com.oracle.cep.api.exceptions
 
com.oracle.cep.api.stage - package com.oracle.cep.api.stage
 
COMBOBOX - Static variable in class com.oracle.cep.api.annotations.OsaConfigWidgetTypes
COMBOBOX widget type shows a combo box containing both text box and dropdown select box
ConfigException - Exception in com.oracle.cep.api.exceptions
Exception for any configuration related errors
ConfigException(String) - Constructor for exception com.oracle.cep.api.exceptions.ConfigException
 
ConfigException(String, Throwable) - Constructor for exception com.oracle.cep.api.exceptions.ConfigException
 
ConfigException(Throwable) - Constructor for exception com.oracle.cep.api.exceptions.ConfigException
 
ConnectorException - Exception in com.oracle.cep.api.exceptions
Exception for any connection related errors
ConnectorException(String) - Constructor for exception com.oracle.cep.api.exceptions.ConnectorException
 
ConnectorException(String, Throwable) - Constructor for exception com.oracle.cep.api.exceptions.ConnectorException
 
ConnectorException(Throwable) - Constructor for exception com.oracle.cep.api.exceptions.ConnectorException
 
Context - Interface in com.oracle.cep.api.adapter
Context is the base interface of AdapterContext and ProcessContext that provides the contextual information to components.
ContextAware<T extends Context> - Interface in com.oracle.cep.api.adapter
This interfaces is required by the extensibility components that needs to receive context and configuration.
ConverterException - Exception in com.oracle.cep.api.exceptions
Exceptions related to any datatype conversions
ConverterException(String) - Constructor for exception com.oracle.cep.api.exceptions.ConverterException
 
ConverterException(String, Throwable) - Constructor for exception com.oracle.cep.api.exceptions.ConverterException
 
ConverterException(Throwable) - Constructor for exception com.oracle.cep.api.exceptions.ConverterException
 
createEvent(EventSpec, Map<String, Object>, long) - Method in interface com.oracle.cep.api.event.EventFactory
Creates an event from pairs of attribute name and value.
createEvent(EventSpec, Object[], long) - Method in interface com.oracle.cep.api.event.EventFactory
Creates an event from the array of attribute values.
createHeartbeat(EventSpec, long) - Method in interface com.oracle.cep.api.event.EventFactory
Creates a heartbeat event

D

DEFAULT_BIGDECIMAL_PRECISION - Static variable in interface com.oracle.cep.api.event.TypeDefaults
 
DEFAULT_BIGDECIMAL_SCALE - Static variable in interface com.oracle.cep.api.event.TypeDefaults
 
DEFAULT_CLASS_NAME - Static variable in interface com.oracle.cep.api.event.TypeDefaults
 
DEFAULT_DATE_FORMAT - Static variable in interface com.oracle.cep.api.event.TypeDefaults
 
DEFAULT_DTS_INTERVAL_FORMAT - Static variable in interface com.oracle.cep.api.event.TypeDefaults
 
DEFAULT_MAX_BYTES - Static variable in interface com.oracle.cep.api.event.TypeDefaults
 
DEFAULT_MAX_CHAR - Static variable in interface com.oracle.cep.api.event.TypeDefaults
 
DEFAULT_ROUNDING_MODE - Static variable in interface com.oracle.cep.api.event.TypeDefaults
 
DEFAULT_TIMESTAMP_FORMAT - Static variable in interface com.oracle.cep.api.event.TypeDefaults
 
DEFAULT_TIMEZONE - Static variable in interface com.oracle.cep.api.event.TypeDefaults
 
DEFAULT_YTM_INTERVAL_FORMAT - Static variable in interface com.oracle.cep.api.event.TypeDefaults
 
DoubleAttr(String) - Static method in class com.oracle.cep.api.event.TupleAttrSpec
 

E

ErrorListener - Interface in com.oracle.cep.api.exceptions
ErrorListener is to send error information to Oracle Stream Analytics.
Event - Interface in com.oracle.cep.api.event
Event is the primary object type of carrying information(data) in Oracle Stream Analytics.
EventFactory - Interface in com.oracle.cep.api.event
Factory for creating events.
EventProcessor - Interface in com.oracle.cep.api.stage
EventProcessor represents the custom stage in Oracle Stream Analytics piepelines.
EventSpec - Interface in com.oracle.cep.api.event
EventSpec represents the specification(schema) of event.
EventSpecAccessor - Interface in com.oracle.cep.api.stage
Marker interface for accepting heartbeat and generating heartbeats.

F

FloatAttr(String) - Static method in class com.oracle.cep.api.event.TupleAttrSpec
 
flush() - Method in interface com.oracle.cep.api.adapter.sink.SinkConnector
Flushes the outputs to the external system if required.
fromAnnotation(String) - Static method in class com.oracle.cep.api.event.TupleAttrSpec
 
fromAnnotation(String) - Static method in class com.oracle.cep.api.event.TupleEventSpec
 

G

generateHeartbeat() - Method in interface com.oracle.cep.api.stage.HeartbeatAware
Generate heartbeat timestamp
GEOMETRY_CLASSNAME - Static variable in interface com.oracle.cep.api.event.TypeDefaults
 
get() - Method in interface com.oracle.cep.api.adapter.source.SourceConnector
Retrieves the data from the external system.
getAttr(int) - Method in interface com.oracle.cep.api.event.Event
Returns the attribute for the given index
getAttr(String) - Method in interface com.oracle.cep.api.event.Event
Returns the attribute for the given attribute name
getAttr(int) - Method in interface com.oracle.cep.api.event.EventSpec
Returns the attribute specification for the given index
getAttr(String) - Method in interface com.oracle.cep.api.event.EventSpec
Returns the attribute specification for the given attribute name
getAttr(int) - Method in class com.oracle.cep.api.event.TupleEventSpec
 
getAttr(String) - Method in class com.oracle.cep.api.event.TupleEventSpec
 
getAttrSpec() - Method in interface com.oracle.cep.api.event.Attr
 
getClsName() - Method in interface com.oracle.cep.api.event.AttrSpec
Returns the fully qualified class name if the data type is OBJECT
getClsName() - Method in class com.oracle.cep.api.event.TupleAttrSpec
 
getContents() - Method in class com.oracle.cep.api.annotations.BaseMessageBundle
 
getDataType() - Method in interface com.oracle.cep.api.event.AttrSpec
 
getDataType() - Method in class com.oracle.cep.api.event.TupleAttrSpec
 
getDateFormat() - Method in interface com.oracle.cep.api.event.AttrSpec
Returns the date format if the datatype is DATE or TIMESTAMP
getDateFormat() - Method in class com.oracle.cep.api.event.TupleAttrSpec
 
getECID() - Method in interface com.oracle.cep.api.adapter.Context
Returns the execution context id associated to the component
getErrorListener() - Method in interface com.oracle.cep.api.adapter.Context
Returns the error listener that receives error information and have Oracle Stream Analytics to process the error
getEventFactory() - Method in interface com.oracle.cep.api.adapter.Context
Returns the event factor to create events
getEventSpec() - Method in interface com.oracle.cep.api.adapter.AdapterContext
Returns the event spec that describes the shape of the event
getId() - Method in interface com.oracle.cep.api.adapter.Context
Returns the id associated to this component
getInputAttrMapping() - Method in interface com.oracle.cep.api.stage.ProcessorContext
Returns the input attribute name mapping.
getInputSpec() - Method in interface com.oracle.cep.api.stage.EventSpecAccessor
 
getIntervalFormat() - Method in interface com.oracle.cep.api.event.AttrSpec
Returns the interval format conforming to the following format if the data type is Interval leading_timeunit - trailing_timeunit timeunits are 'nanoseconds', 'microseconds', 'milliseconds', 'seconds', 'minutes', 'hours', 'days', 'months', 'years'
getIntervalFormat() - Method in class com.oracle.cep.api.event.TupleAttrSpec
 
getLength() - Method in interface com.oracle.cep.api.event.AttrSpec
 
getLength() - Method in class com.oracle.cep.api.event.TupleAttrSpec
 
getName() - Method in interface com.oracle.cep.api.event.Attr
 
getName() - Method in interface com.oracle.cep.api.event.AttrSpec
 
getName() - Method in interface com.oracle.cep.api.event.EventSpec
 
getName() - Method in class com.oracle.cep.api.event.TupleAttrSpec
 
getName() - Method in class com.oracle.cep.api.event.TupleEventSpec
 
getNoAttributes() - Method in interface com.oracle.cep.api.event.Event
 
getNoAttrs() - Method in interface com.oracle.cep.api.event.EventSpec
 
getNoAttrs() - Method in class com.oracle.cep.api.event.TupleEventSpec
 
getObjectValue() - Method in interface com.oracle.cep.api.event.Attr
 
getOutputSpec() - Method in interface com.oracle.cep.api.stage.EventSpecAccessor
 
getParam(String) - Method in interface com.oracle.cep.api.adapter.Context
Retrives the parameter associated to the given key
getPrecision() - Method in interface com.oracle.cep.api.event.AttrSpec
 
getPrecision() - Method in class com.oracle.cep.api.event.TupleAttrSpec
 
getRoundingMode() - Method in interface com.oracle.cep.api.event.AttrSpec
 
getRoundingMode() - Method in class com.oracle.cep.api.event.TupleAttrSpec
 
getScale() - Method in interface com.oracle.cep.api.event.AttrSpec
 
getScale() - Method in class com.oracle.cep.api.event.TupleAttrSpec
 
getTime() - Method in interface com.oracle.cep.api.event.Event
 
getTimeZone() - Method in interface com.oracle.cep.api.event.AttrSpec
Returns the timezone if the datatype is DATE or TIMESTAMP
getTimeZone() - Method in class com.oracle.cep.api.event.TupleAttrSpec
 

H

HeartbeatAware - Interface in com.oracle.cep.api.stage
Marker interface for accepting heartbeat and generating heartbeats.

I

init(T, Map<String, String>) - Method in interface com.oracle.cep.api.adapter.ContextAware
Callback method for receiving context and configuration.
IntAttr(String) - Static method in class com.oracle.cep.api.event.TupleAttrSpec
 
INTEGER - Static variable in class com.oracle.cep.api.annotations.OsaConfigWidgetTypes
INTEGER widget type shows a regular text box for integer datatype
IntervalAttr(String) - Static method in class com.oracle.cep.api.event.TupleAttrSpec
 
IntervalAttr(String, String) - Static method in class com.oracle.cep.api.event.TupleAttrSpec
 
isHeartbeat() - Method in interface com.oracle.cep.api.event.Event
 
isNull() - Method in interface com.oracle.cep.api.event.Attr
 

N

NUMBER - Static variable in class com.oracle.cep.api.annotations.OsaConfigWidgetTypes
NUMBER widget type shows a regular text box for number datatype

O

ObjAttr(String) - Static method in class com.oracle.cep.api.event.TupleAttrSpec
 
ObjAttr(String, String) - Static method in class com.oracle.cep.api.event.TupleAttrSpec
 
onError(String, String, String, Object, Throwable) - Method in interface com.oracle.cep.api.exceptions.ErrorListener
Handles the given error.
OsaConfigParam - Annotation Type in com.oracle.cep.api.annotations
OsaConfigParam defines the configuration parameter for the user interface.
OsaConfigWidgetTypes - Class in com.oracle.cep.api.annotations
OsaConfigWidgetTypes defines the widget type that is shown in UI
OsaConfigWidgetTypes() - Constructor for class com.oracle.cep.api.annotations.OsaConfigWidgetTypes
 
OsaConverter - Annotation Type in com.oracle.cep.api.annotations
OsaConverter defines a custom converter that can be plugged into Oracle Stream Analytics.
OsaFunction - Annotation Type in com.oracle.cep.api.annotations
OsaFunction defines a custom function that can be plugged into Oracle Stream Analytics.
OsaSinkConnector - Annotation Type in com.oracle.cep.api.annotations
OsaSinkConnector defines a SinkConnector that can be plugged into Oracle Stream Analytics.
OsaSourceConnector - Annotation Type in com.oracle.cep.api.annotations
OsaSourceConnector defines a SourceConnector that can be plugged into Oracle Stream Analytics.
OsaStage - Annotation Type in com.oracle.cep.api.annotations
OsaStage defines a custom stage that can be plugged into Oracle Stream Analytics.

P

PASSWORD - Static variable in class com.oracle.cep.api.annotations.OsaConfigWidgetTypes
PASSWORD widget type shows a password type of text box where the contents are hidden
process(Iterator<Event>) - Method in interface com.oracle.cep.api.adapter.sink.SinkConverter
Converts the Oracle Stream Analytics Events format to external data format.
process(Iterator<Object>) - Method in interface com.oracle.cep.api.adapter.source.SourceConverter
Processes the input data in external data format and converts to Oracle Stream Analytics Event format.
processEvent(Event) - Method in interface com.oracle.cep.api.stage.EventProcessor
Process a single event
processEvents(Iterator<Event>) - Method in interface com.oracle.cep.api.stage.BatchEventProcessor
Process input events and generate output events
ProcessorContext - Interface in com.oracle.cep.api.stage
ProcessorContext provides the contextual information for the stage processors It holds the same information as Context with additional input attribute mappings.
put(Iterator<Object>) - Method in interface com.oracle.cep.api.adapter.sink.SinkConnector
Put the data into the external system.

S

SELECT - Static variable in class com.oracle.cep.api.annotations.OsaConfigWidgetTypes
SELECT widget type shows a dropdown select box
setInputSpec(EventSpec) - Method in interface com.oracle.cep.api.stage.EventSpecAccessor
 
setName(String) - Method in interface com.oracle.cep.api.event.Attr
Sets the name of attribute
setName(String) - Method in class com.oracle.cep.api.event.TupleAttrSpec
 
setNull(boolean) - Method in interface com.oracle.cep.api.event.Attr
Sets if the attribute contains null value
setObjectValue(Object) - Method in interface com.oracle.cep.api.event.Attr
Sets the value of attribute
setOutputSpec(EventSpec) - Method in interface com.oracle.cep.api.stage.EventSpecAccessor
 
setParam(String, Object) - Method in interface com.oracle.cep.api.adapter.Context
Puts the parameter object with a key into the context
setTime(long) - Method in interface com.oracle.cep.api.event.Event
Sets the timestamp
SinkConnector - Interface in com.oracle.cep.api.adapter.sink
SinkConnectors represent the sink connector that receives the data and send it to an external system.
SinkConverter - Interface in com.oracle.cep.api.adapter.sink
SinkConverters represent the sink side converters that converts Oracle Stream Analytics Event format to external data format.
SourceConnector - Interface in com.oracle.cep.api.adapter.source
SourceConnectors represent the source connector that pulls the data from an external system.
SourceConverter - Interface in com.oracle.cep.api.adapter.source
SourceConverter represent the source side converters that converts the external data format to Oracle Stream Analytics Event format.
StageException - Exception in com.oracle.cep.api.exceptions
Exceptions related to any custom stages
StageException(String) - Constructor for exception com.oracle.cep.api.exceptions.StageException
 
StageException(String, Throwable) - Constructor for exception com.oracle.cep.api.exceptions.StageException
 
StageException(Throwable) - Constructor for exception com.oracle.cep.api.exceptions.StageException
 
STRING - Static variable in class com.oracle.cep.api.annotations.OsaConfigWidgetTypes
STRING widget type shows a regular text box for string datatype

T

TimestampAttr(String) - Static method in class com.oracle.cep.api.event.TupleAttrSpec
 
TimestampAttr(String, String, String) - Static method in class com.oracle.cep.api.event.TupleAttrSpec
 
toString() - Method in class com.oracle.cep.api.event.TupleAttrSpec
 
toString() - Method in class com.oracle.cep.api.event.TupleEventSpec
 
TupleAttrSpec - Class in com.oracle.cep.api.event
TupleAttrSpec is the base implementation of Attribute Specification.
TupleEventSpec - Class in com.oracle.cep.api.event
TupleEventSpec is the base implementation of Event Specification.
TupleEventSpec(String, AttrSpec[]) - Constructor for class com.oracle.cep.api.event.TupleEventSpec
 
TypeDefaults - Interface in com.oracle.cep.api.event
The default parameters for AggrDataTypes.

V

valueOf(String) - Static method in enum com.oracle.cep.api.event.AttrDataType
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.oracle.cep.api.event.AttrDataType
Returns an array containing the constants of this enum type, in the order they are declared.
VarByteAttr(String) - Static method in class com.oracle.cep.api.event.TupleAttrSpec
 
VarByteAttr(String, int) - Static method in class com.oracle.cep.api.event.TupleAttrSpec
 
VarCharAttr(String) - Static method in class com.oracle.cep.api.event.TupleAttrSpec
 
VarCharAttr(String, int) - Static method in class com.oracle.cep.api.event.TupleAttrSpec
 
A B C D E F G H I N O P S T V 
Skip navigation links
Spark CQL Extensibility Java API Reference for Oracle Stream Analytics
Release 18.1.0.0.1

E93123-02

Copyright © 2018, Oracle and/or its affiliates. All rights reserved.