Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Event Processing
11g Release 1 (11.1.1.7)

E14303-11
FRAMES    NO FRAMES
DETAIL:  FIELD | CONSTR | METHOD


com.bea.wlevs.ede.api
Interface EventChannel


public interface EventChannel
extends Stage, EventQueue, HeartbeatAware, com.bea.wlevs.ede.api.EventSinkManager, BatchRelationSink, BatchStreamSink

A event channel is a conduit for events. Event channels support two types of modeling, streams and relations. Streams are append-only, that is, events are always appended to the end of the stream. Relations support events that insert, delete, and update its content. Events send to channels must have non-decreasing time-stamps.


Method Summary
 java.lang.String getEventType()
          Only events of this event type are allowed to pass through this event channel.
 java.lang.String getId()
          Returns the event channel identity
 java.lang.Integer getPartitionOrderCapacity()
          The capacity (i.e.number of buckets) of partition used for partition-ordered sources (e.g. relation/stream).
 java.util.List getPrimaryKey()
          Returns primary key of relation, or an empty list for streams.
 java.lang.String getTimestampExpression()
          Returns expression used to calculate the application timestamp.
 boolean isApplicationTimestamped()
          Returns if channel is application timestamped, that is, application is responsible for assigning a timestamp to each event.
 boolean isBatchEvents()
          Returns if channel is batching over timestamp
 boolean isRelation()
          Returns if event channel is carrying relations, instead of streams.
 boolean isSystemTimestamped()
          Returns if channel is system timestamped, that is, the system is responsible for assigning a timestamp to each event.
 boolean isTotalOrder()
          Returns if application time published is always strictly greater than the last value used.

 

Methods inherited from interface com.bea.wlevs.ede.api.EventQueue
getCurrentSize, getMaxSize, getMaxThreads, getOfferTimeout, isFailWhenRejected, setFailWhenRejected, setMaxSize, setMaxThreads, setOfferTimeout

 

Methods inherited from interface com.bea.wlevs.ede.api.HeartbeatAware
onHeartbeat

 

Methods inherited from interface com.bea.wlevs.ede.api.BatchRelationSink
onEvents

 

Methods inherited from interface com.bea.wlevs.ede.api.BatchStreamSink
onInsertEvents

 

Methods inherited from interface com.bea.wlevs.ede.api.EventSender
sendEvent

 

Methods inherited from interface com.bea.wlevs.ede.api.BatchRelationSender
sendEvents

 

Methods inherited from interface com.bea.wlevs.ede.api.BatchStreamSender
sendInsertEvents

 

Methods inherited from interface com.bea.wlevs.ede.api.RelationSender
sendDeleteEvent, sendUpdateEvent

 

Methods inherited from interface com.bea.wlevs.ede.api.RelationSink
onDeleteEvent, onUpdateEvent

 

Method Detail

getId

public java.lang.String getId()
Returns the event channel identity
Returns:
identity

getEventType

public java.lang.String getEventType()
Only events of this event type are allowed to pass through this event channel.
Returns:
event type name

getTimestampExpression

public java.lang.String getTimestampExpression()
Returns expression used to calculate the application timestamp.
Parameters:
expression -  

isRelation

public boolean isRelation()
Returns if event channel is carrying relations, instead of streams.
Returns:
boolean

getPrimaryKey

public java.util.List getPrimaryKey()
Returns primary key of relation, or an empty list for streams.
Returns:
list of property names used as primary key for relation

isTotalOrder

public boolean isTotalOrder()
Returns if application time published is always strictly greater than the last value used.
Returns:
boolean

isSystemTimestamped

public boolean isSystemTimestamped()
Returns if channel is system timestamped, that is, the system is responsible for assigning a timestamp to each event. This is done using System.nanoTime().
Returns:
boolean

isApplicationTimestamped

public boolean isApplicationTimestamped()
Returns if channel is application timestamped, that is, application is responsible for assigning a timestamp to each event. Application may use any time domain.
Returns:
boolean

isBatchEvents

public boolean isBatchEvents()
Returns if channel is batching over timestamp
Returns:
boolean

getPartitionOrderCapacity

public java.lang.Integer getPartitionOrderCapacity()
The capacity (i.e.number of buckets) of partition used for partition-ordered sources (e.g. relation/stream). This is used by downstream processors when executing partition-ordered queries and views. If not set and max-threads is greater than zero, then it is assumed to be equal to max-threads. If max-threads is not greater than zero, then the server's global partition-buckets configuration in the 'cql' section is used. If this is not set, then a default of 4 is used. A channel that is not connected to a processor does not have a partition order capacity and therefore returns null if not explicitly configured with a value.
Returns:
Integer partition capacity, or null if not applicable

Overview  Package   Class   Use  Tree  Deprecated  Index  Help 
Copyright © 2007, 2013 Oracle and/or its affiliates. All rights reserved.
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD