public interface DatagramPrototypeCache
Title: Structured Data Objects
Description: Defines a cache that contains all Event Prototypes.
Prototype
object and unique string Event Id associated with it
(so, an event prototype can be uniquely determined either by its Prototype
or by its Event Id).
Copyright: Copyright (c) 2010
Company: StreamScape Technologies
Modifier and Type | Method and Description |
---|---|
boolean |
existsEventId(java.lang.String eventId)
Checks if the event prototype associated with the specified event id exists in the cache.
|
boolean |
existsPrototype(Prototype prototype)
Checks if an event prototype associated with the specified
Prototype object exists in the cache. |
java.lang.String |
getAncestor(Prototype prototype)
Returns an ancestor Semantic Type of an event prototype associated with the specified
Prototype object. |
java.lang.String |
getAncestor(java.lang.String eventId)
Returns an ancestor Semantic Type of the event prototype associated with the specified event id.
|
java.lang.String |
getModel(java.lang.String eventId)
Returns a model of the event prototype associated with the specified event id.
|
java.util.List |
getPrototypes()
Returns a list of
Prototype objects of all event prototypes in the cache. |
java.util.List |
getPrototypesByAncestor(java.lang.String ancestor,
boolean includeModels)
Returns a list of
Prototype objects associated with the event prototypes that have the specified ancestor. |
java.util.List |
getPrototypesByDataType(SemanticType type)
Returns a list of
Prototype objects associated with the event prototypes
that have a payload object of the specified SemanticType. |
java.util.List |
listEventIds()
Returns a sorted list of event ids of all event prototypes in the cache (the list is sorted by alphabetical order).
|
java.util.List |
listEventIdsByAncestor(java.lang.String ancestor)
Returns a sorted list of event ids of event prototypes that have the specified ancestor.
|
java.util.List |
listEventIdsByDataType(SemanticType type)
Returns a list of event ids associated with the event prototypes that have a payload object of the specified SemanticType.
|
java.util.List |
listEventIdsByFilter(Filter filter)
Returns a sorted list of event ids that match to the specified filter (the list is sorted by alphabetical order).
|
java.lang.String |
lookupEventId(Prototype prototype)
Returns the event id corresponding to the specified
Prototype object. |
Prototype |
lookupPrototype(java.lang.String eventId)
Returns the
Prototype object corresponding to the specified event id. |
boolean existsEventId(java.lang.String eventId)
eventId
- the specified event id.true
if the corresponding event prototype exists in the cache, false
otherwise.java.lang.String getAncestor(java.lang.String eventId) throws DatagramFactoryException
Supported ancestors are the following:
AdvisoryEventDatagram
(see AdvisoryDatagramFactory
)EventDatagram
(see EventDatagramFactory
)ExceptionEventDatagram
(see ExceptionDatagramFactory
)OpaqueDatagram
(see OpaqueDatagramFactory
)eventId
- the specified event id.DatagramFactoryManagerException
- if the corresponding event prototype does not exist in the cache.DatagramFactoryException
java.lang.String getModel(java.lang.String eventId) throws DatagramFactoryException
DatagramPrototypeFactory
to get a list of supported models.eventId
- the specified event id.DatagramFactoryException
- if the corresponding event prototype does not exist in the cache.java.util.List listEventIds()
java.util.List listEventIdsByAncestor(java.lang.String ancestor)
Supported ancestors are the following:
AdvisoryEventDatagram
(see AdvisoryDatagramFactory
)EventDatagram
(see EventDatagramFactory
)ExceptionEventDatagram
(see ExceptionDatagramFactory
)OpaqueDatagram
(see OpaqueDatagramFactory
)ancestor
- the specified ancestor.java.util.List listEventIdsByFilter(Filter filter)
filter
- the specified filter.java.lang.String lookupEventId(Prototype prototype)
Prototype
object.prototype
- the specified prototype.null
if this prototype does not exist.Prototype lookupPrototype(java.lang.String eventId)
Prototype
object corresponding to the specified event id.eventId
- the specified event id.Prototype
object associated with the corresponding event prototype or
null
if this prototype does not exist.boolean existsPrototype(Prototype prototype)
Prototype
object exists in the cache.prototype
- the specified prototype.true
if the corresponding event prototype exists in the cache, false
otherwise.java.lang.String getAncestor(Prototype prototype) throws DatagramFactoryException
Prototype
object.
Supported ancestors are the following:
AdvisoryEventDatagram
(see AdvisoryDatagramFactory
)EventDatagram
(see EventDatagramFactory
)ExceptionEventDatagram
(see ExceptionDatagramFactory
)OpaqueDatagram
(see OpaqueDatagramFactory
)prototype
- the specified prototype.DatagramFactoryManagerException
- if the corresponding event prototype does not exist in the cache.DatagramFactoryException
java.util.List getPrototypes()
Prototype
objects of all event prototypes in the cache.java.util.List getPrototypesByAncestor(java.lang.String ancestor, boolean includeModels)
Prototype
objects associated with the event prototypes that have the specified ancestor.
Supported ancestors are the following:
AdvisoryEventDatagram
(see AdvisoryDatagramFactory
)EventDatagram
(see EventDatagramFactory
)ExceptionEventDatagram
(see ExceptionDatagramFactory
)OpaqueDatagram
(see OpaqueDatagramFactory
)ancestor
- the specified ancestor.includeModels
- the flag indicating if model prototypes will be also included to the result list.Prototype
objects.java.util.List getPrototypesByDataType(SemanticType type)
Prototype
objects associated with the event prototypes
that have a payload object of the specified SemanticType.
PayloadEvent
prototype models.type
- the semantic type of a payload object.Prototype
objects.java.util.List listEventIdsByDataType(SemanticType type)
PayloadEvent
prototype models.type
- the semantic type of a payload object.Copyright © 2015-2024 StreamScape Technologies. All rights reserved.