won.protocol.service

Interface LinkedDataService

public interface LinkedDataService

User: fkleedorfer Date: 26.11.12

Method Summary

Modifier and Type	Method and Description
DataWithEtag<org.apache.jena.query.Dataset>	getConnectionDataset(java.net.URI connectionUri, boolean includeEventContainer, boolean includeLatestEvent, java.lang.String etag) Returns a dataset describing the connection, if the etag indicates that it has changed.
DataWithEtag<org.apache.jena.query.Dataset>	getDatasetForUri(java.net.URI eventURI, java.lang.String etag) returns a dataset of the (message) event with the specified URI, with a value that can be used for an etag.
org.apache.jena.query.Dataset	getNeedDataset(java.net.URI needUri, boolean deep, java.lang.Integer deepLayerSize) Returns a dataset describing the need with the specified URI.
DataWithEtag<org.apache.jena.query.Dataset>	getNeedDataset(java.net.URI needUri, java.lang.String etag) Returns a dataset describing the need, if the etag indicates that it has changed.
org.apache.jena.query.Dataset	getNodeDataset()
org.apache.jena.rdf.model.Model	getUnreadInformationForNeed(java.net.URI needURI, java.util.Collection<java.net.URI> lastSeenMessageURIs) Returns a model specifying the number of messages and their latest and earliest timestamp found per connection after the specified lastSeenMessageURI, or the total message count and respective timestamps for a connection for which no lastSeenMessageURI is specified.
org.apache.jena.query.Dataset	listConnectionEventURIs(java.net.URI connectionUri) Returns a dataset containing all event uris belonging to the specified connection.
org.apache.jena.query.Dataset	listConnectionEventURIs(java.net.URI connectionUri, boolean deep) Returns a dataset containing all event uris belonging to the specified connection.
NeedInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI>	listConnectionEventURIs(java.net.URI connectionUri, int pageNum, java.lang.Integer preferedSize, WonMessageType messageType, boolean deep) Returns paged resource containing all event uris belonging to the specified connection.
NeedInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI>	listConnectionEventURIsAfter(java.net.URI connectionUri, java.net.URI msgURI, java.lang.Integer preferedSize, WonMessageType msgType, boolean deep) Returns a dataset containing all event uris belonging to the specified connection that were created after the specified event uri.
NeedInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI>	listConnectionEventURIsBefore(java.net.URI connectionUri, java.net.URI msgURI, java.lang.Integer preferedSize, WonMessageType msgType, boolean deep) Returns a dataset containing all event uris belonging to the specified connection that were created before the specified event uri.
org.apache.jena.query.Dataset	listConnectionURIs(boolean deep) Returns container dataset containing all connection URIs.
NeedInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI>	listConnectionURIs(int page, java.lang.Integer preferredSize, java.util.Date timeSpot, boolean deep) Returns a resource containing connection uris at given page.
NeedInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI>	listConnectionURIs(int page, java.net.URI needURI, java.lang.Integer preferredSize, WonMessageType messageType, java.util.Date timeSpot, boolean deep, boolean addMetadata) Returns paged resource containing all connection uris belonging to the specified need.
org.apache.jena.query.Dataset	listConnectionURIs(java.net.URI needURI, boolean deep, boolean addMetadata) Returns a model containing all connection uris belonging to the specified need.
NeedInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI>	listConnectionURIsAfter(java.net.URI afterConnURI, java.lang.Integer preferredSize, java.util.Date timeSpot, boolean deep) Returns a resource containing connection uris that follow (by time of their latest event activities) the given connection as of state that was at the specified time.
NeedInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI>	listConnectionURIsAfter(java.net.URI needURI, java.net.URI resumeConnURI, java.lang.Integer preferredSize, WonMessageType messageType, java.util.Date timeSpot, boolean deep, boolean addMetadata) Returns paged resource containing all connection uris belonging to the specified need that follows the given connection URI from the point of view of their latest events.
NeedInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI>	listConnectionURIsBefore(java.net.URI beforeConnURI, java.lang.Integer preferredSize, java.util.Date timeSpot, boolean deep) Returns a resource containing connection uris that precede (by time of their latest event activities) the given connection as of state that was at the specified time.
NeedInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI>	listConnectionURIsBefore(java.net.URI needURI, java.net.URI resumeConnURI, java.lang.Integer preferredSize, WonMessageType messageType, java.util.Date timeSpot, boolean deep, boolean addMetadata) Returns paged resource containing all connection uris belonging to the specified need that precede the given connection URI from the point of view of their latest events.
org.apache.jena.query.Dataset	listModifiedConnectionURIsAfter(java.util.Date modifiedAfter, boolean deep) Returns container dataset containing all connection URIs that where modified after a certain date.
org.apache.jena.query.Dataset	listModifiedNeedURIsAfter(java.util.Date modifiedDate) Returns container dataset containing all needs that have been modified after a certain date
org.apache.jena.query.Dataset	listNeedURIs() Returns a model containing all need URIs.
NeedInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI>	listNeedURIs(int page) Returns a model containing all need URIs.
NeedInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI>	listNeedURIs(int page, java.lang.Integer preferedSize, NeedState needState) Returns a model containing all need URIs that are in the specified state.
NeedInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI>	listNeedURIsAfter(java.net.URI need) Return all need URIs that where created after the provided need
NeedInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI>	listNeedURIsAfter(java.net.URI need, java.lang.Integer preferedSize, NeedState needState) Return all need URIs that where created after the provided need and that are in the specified state
NeedInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI>	listNeedURIsBefore(java.net.URI need) Return all need URIs that where created before the provided need
NeedInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI>	listNeedURIsBefore(java.net.URI need, java.lang.Integer preferedSize, NeedState needState) Return all need URIs that where created after the provided need and that are in the specified state

Method Detail

listNeedURIs

org.apache.jena.query.Dataset listNeedURIs()

Returns a model containing all need URIs.

Returns:

listNeedURIs

NeedInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI> listNeedURIs(int page)

Returns a model containing all need URIs. If page >= 0, paging is used and the respective page is returned.

Parameters:

page -

Returns:

listNeedURIs

NeedInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI> listNeedURIs(int page,
                                                                                              java.lang.Integer preferedSize,
                                                                                              NeedState needState)

Returns a model containing all need URIs that are in the specified state. If page >= 0, paging is used and the respective page is returned.

Parameters:

page -

preferedSize - preferred number of need uris per page (null means use default)

needState -

Returns:

listNeedURIsBefore

NeedInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI> listNeedURIsBefore(java.net.URI need)

Return all need URIs that where created before the provided need

Parameters:

need -

Returns:

listNeedURIsAfter

NeedInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI> listNeedURIsAfter(java.net.URI need)

Return all need URIs that where created after the provided need

Parameters:

need -

Returns:

listNeedURIsBefore

NeedInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI> listNeedURIsBefore(java.net.URI need,
                                                                                                    java.lang.Integer preferedSize,
                                                                                                    NeedState needState)

Return all need URIs that where created after the provided need and that are in the specified state

Parameters:

need -

preferedSize - preferred number of need uris per page (null means use default)

needState -

Returns:

listNeedURIsAfter

NeedInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI> listNeedURIsAfter(java.net.URI need,
                                                                                                   java.lang.Integer preferedSize,
                                                                                                   NeedState needState)

Return all need URIs that where created after the provided need and that are in the specified state

Parameters:

need -

preferedSize - preferred number of need uris per page (null means use default)

needState -

Returns:

listModifiedNeedURIsAfter

org.apache.jena.query.Dataset listModifiedNeedURIsAfter(java.util.Date modifiedDate)

Returns container dataset containing all needs that have been modified after a certain date

Parameters:

modifiedDate - modification date of needs

Returns:

listConnectionURIs

org.apache.jena.query.Dataset listConnectionURIs(boolean deep)
                                          throws NoSuchConnectionException

Returns container dataset containing all connection URIs. If deep is true, the resource data of those connection uris is also part of the returned resource.

Parameters:

deep -

Returns:

Throws:

NoSuchConnectionException - only in case deep is set to true and connection data for a member connection uri cannot be retrieved.

listModifiedConnectionURIsAfter

org.apache.jena.query.Dataset listModifiedConnectionURIsAfter(java.util.Date modifiedAfter,
                                                              boolean deep)
                                                       throws NoSuchConnectionException

Returns container dataset containing all connection URIs that where modified after a certain date.

Parameters:

modifiedAfter - modification date

deep - If deep is true, the resource data of those connection uris is also part of the returned resource.

Returns:

Throws:

NoSuchConnectionException

listConnectionURIs

NeedInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI> listConnectionURIs(int page,
                                                                                                    java.lang.Integer preferredSize,
                                                                                                    java.util.Date timeSpot,
                                                                                                    boolean deep)
                                                                                             throws NoSuchConnectionException

Returns a resource containing connection uris at given page. If deep is true, the resource data of those connection uris is also part of the returned resource. If page >0, paging is used and the respective page is returned.

Parameters:

page -

preferredSize - preferred number of connection uris per page (null means use default)

deep -

Returns:

Throws:

NoSuchNeedException

NoSuchConnectionException

listConnectionURIsBefore

NeedInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI> listConnectionURIsBefore(java.net.URI beforeConnURI,
                                                                                                          java.lang.Integer preferredSize,
                                                                                                          java.util.Date timeSpot,
                                                                                                          boolean deep)
                                                                                                   throws NoSuchConnectionException

Returns a resource containing connection uris that precede (by time of their latest event activities) the given connection as of state that was at the specified time.

Parameters:

beforeConnURI - a connection the preceding connections of which we are interested in

preferredSize - preferred number of connection uris per page (null means use default)

timeSpot - date and time that specifies the connections and events state of interest

deep - if true, the resource data of those connection uris is also part of the resource

Returns:

Throws:

NoSuchNeedException

NoSuchConnectionException - only in case deep is set to true and connection data for a member connection uri cannot be retrieved.

listConnectionURIsAfter

NeedInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI> listConnectionURIsAfter(java.net.URI afterConnURI,
                                                                                                         java.lang.Integer preferredSize,
                                                                                                         java.util.Date timeSpot,
                                                                                                         boolean deep)
                                                                                                  throws NoSuchConnectionException

Returns a resource containing connection uris that follow (by time of their latest event activities) the given connection as of state that was at the specified time.

Parameters:

afterConnURI - a connection the following connections of which we are interested in

preferredSize - preferred number of connection uris per page (null means use default)

timeSpot - date and time that specifies the connections and events state of interest

deep - if true, the resource data of those connection uris is also part of the resource

Returns:

Throws:

NoSuchNeedException

NoSuchConnectionException - only in case deep is set to true and connection data for a member connection uri cannot be retrieved.

listConnectionURIs

org.apache.jena.query.Dataset listConnectionURIs(java.net.URI needURI,
                                                 boolean deep,
                                                 boolean addMetadata)
                                          throws NoSuchNeedException,
                                                 NoSuchConnectionException

Returns a model containing all connection uris belonging to the specified need.

Parameters:

needURI -

addMetadata - - if true, a metadata graph is added to the dataset containing counts by connection state

deep - - if true, connection data is added (not only connection URIs)

Returns:

Throws:

NoSuchNeedException

NoSuchConnectionException

listConnectionURIs

NeedInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI> listConnectionURIs(int page,
                                                                                                    java.net.URI needURI,
                                                                                                    java.lang.Integer preferredSize,
                                                                                                    WonMessageType messageType,
                                                                                                    java.util.Date timeSpot,
                                                                                                    boolean deep,
                                                                                                    boolean addMetadata)
                                                                                             throws NoSuchNeedException,
                                                                                                    NoSuchConnectionException

Returns paged resource containing all connection uris belonging to the specified need.

Parameters:

page - number

preferredSize - preferred number of connection uris per page (null means use default)

needURI - local need the connections of which are retrieved

messageType - the event type that should be used for defining connection latest activity; null => all event types

timeSpot - time at which we want the list state to be fixed

deep - if true, the resource data of those connection uris is also part of the resource

addMetadata - - if true, a metadata graph is added to the dataset containing counts by connection state

Returns:

Throws:

NoSuchNeedException - when specified need is not found

NoSuchConnectionException - only in case deep is set to true and connection data for a member connection uri cannot be retrieved.

listConnectionURIsBefore

NeedInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI> listConnectionURIsBefore(java.net.URI needURI,
                                                                                                          java.net.URI resumeConnURI,
                                                                                                          java.lang.Integer preferredSize,
                                                                                                          WonMessageType messageType,
                                                                                                          java.util.Date timeSpot,
                                                                                                          boolean deep,
                                                                                                          boolean addMetadata)
                                                                                                   throws NoSuchNeedException,
                                                                                                          NoSuchConnectionException

Returns paged resource containing all connection uris belonging to the specified need that precede the given connection URI from the point of view of their latest events.

Parameters:

needURI - local need the connections of which are retrieved

resumeConnURI - the returned slice connections precede (in time of their latest events) this connection uri

preferredSize - preferred number of connection uris per page (null means use default)

messageType - the event type that should be used for defining connection latest activity; null => all event types

timeSpot - time at which we want the list state to be fixed

deep - if true, the resource data of those connection uris is also part of the resource

addMetadata - - if true, a metadata graph is added to the dataset containing counts by connection state

Returns:

Throws:

NoSuchNeedException - when specified need is not found

NoSuchConnectionException - only in case deep is set to true and connection data for a member connection uri cannot be retrieved.

listConnectionURIsAfter

NeedInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI> listConnectionURIsAfter(java.net.URI needURI,
                                                                                                         java.net.URI resumeConnURI,
                                                                                                         java.lang.Integer preferredSize,
                                                                                                         WonMessageType messageType,
                                                                                                         java.util.Date timeSpot,
                                                                                                         boolean deep,
                                                                                                         boolean addMetadata)
                                                                                                  throws NoSuchNeedException,
                                                                                                         NoSuchConnectionException

Returns paged resource containing all connection uris belonging to the specified need that follows the given connection URI from the point of view of their latest events.

Parameters:

needURI - local need the connections of which are retrieved

resumeConnURI - the returned slice connections follow (in time of their latest events) this connection uri

preferredSize - preferred number of connection uris per page (null means use default)

messageType - the event type that should be used for defining connection latest activity; null => all event types

timeSpot - time at which we want the list state to be fixed

deep - if true, the resource data of those connection uris is also part of the resource

addMetadata - - if true, a metadata graph is added to the dataset containing counts by connection state

Returns:

Throws:

NoSuchNeedException - when specified need is not found

NoSuchConnectionException - only in case deep is set to true and connection data for a member connection uri cannot be retrieved.

getNeedDataset

DataWithEtag<org.apache.jena.query.Dataset> getNeedDataset(java.net.URI needUri,
                                                           java.lang.String etag)

Returns a dataset describing the need, if the etag indicates that it has changed.

Parameters:

needUri -

etag -

Returns:

dataset with etag describing the need or null if not found

getNeedDataset

org.apache.jena.query.Dataset getNeedDataset(java.net.URI needUri,
                                             boolean deep,
                                             java.lang.Integer deepLayerSize)
                                      throws NoSuchNeedException,
                                             NoSuchConnectionException,
                                             org.springframework.context.NoSuchMessageException

Returns a dataset describing the need with the specified URI. If the need is in state ACTIVE, 'deep' data is added if requested.

Parameters:

needUri -

deep - - include need's connections datasets and each connection's events' datasets

deepLayerSize - - number of connections and events to include in the deep need dataset

Returns:

Throws:

NoSuchNeedException

NoSuchConnectionException

org.springframework.context.NoSuchMessageException

getConnectionDataset

DataWithEtag<org.apache.jena.query.Dataset> getConnectionDataset(java.net.URI connectionUri,
                                                                 boolean includeEventContainer,
                                                                 boolean includeLatestEvent,
                                                                 java.lang.String etag)

Returns a dataset describing the connection, if the etag indicates that it has changed.

Parameters:

connectionUri -

includeEventContainer -

includeLatestEvent -

etag -

Returns:

Throws:

NoSuchConnectionException

listConnectionEventURIs

org.apache.jena.query.Dataset listConnectionEventURIs(java.net.URI connectionUri)
                                               throws NoSuchConnectionException

Returns a dataset containing all event uris belonging to the specified connection.

Parameters:

connectionUri -

Returns:

Throws:

NoSuchConnectionException

listConnectionEventURIs

org.apache.jena.query.Dataset listConnectionEventURIs(java.net.URI connectionUri,
                                                      boolean deep)
                                               throws NoSuchConnectionException

Returns a dataset containing all event uris belonging to the specified connection.

Parameters:

connectionUri -

deep - - include events dataset

Returns:

Throws:

NoSuchConnectionException

listConnectionEventURIs

NeedInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI> listConnectionEventURIs(java.net.URI connectionUri,
                                                                                                         int pageNum,
                                                                                                         java.lang.Integer preferedSize,
                                                                                                         WonMessageType messageType,
                                                                                                         boolean deep)
                                                                                                  throws NoSuchConnectionException

Returns paged resource containing all event uris belonging to the specified connection. If deep is true, the event dataset is added to the result.

Parameters:

connectionUri - connection parent of the events

pageNum - number of the page to be returned

preferedSize - preferred number of uris per page, null means use default

messageType - message type, null means all types

deep -

Returns:

Throws:

NoSuchConnectionException

listConnectionEventURIsAfter

NeedInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI> listConnectionEventURIsAfter(java.net.URI connectionUri,
                                                                                                              java.net.URI msgURI,
                                                                                                              java.lang.Integer preferedSize,
                                                                                                              WonMessageType msgType,
                                                                                                              boolean deep)
                                                                                                       throws NoSuchConnectionException

Returns a dataset containing all event uris belonging to the specified connection that were created after the specified event uri. If deep is true, the event dataset is added to the result.

Parameters:

connectionUri - connection parent of the events

msgURI - message to follow (in message creation time)

preferedSize - preferred number of uris per page, null means use default

msgType - message type, null means all types

deep -

Returns:

Throws:

NoSuchConnectionException

listConnectionEventURIsBefore

NeedInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI> listConnectionEventURIsBefore(java.net.URI connectionUri,
                                                                                                               java.net.URI msgURI,
                                                                                                               java.lang.Integer preferedSize,
                                                                                                               WonMessageType msgType,
                                                                                                               boolean deep)
                                                                                                        throws NoSuchConnectionException

Returns a dataset containing all event uris belonging to the specified connection that were created before the specified event uri. If deep is true, the event dataset is added to the result.

Parameters:

connectionUri - connection parent of the events

msgURI - message to precede (in message creation time)

preferedSize - preferred number of uris per page, null means use default

msgType - message type, null means all types

deep -

Returns:

Throws:

NoSuchConnectionException

getNodeDataset

org.apache.jena.query.Dataset getNodeDataset()

getDatasetForUri

DataWithEtag<org.apache.jena.query.Dataset> getDatasetForUri(java.net.URI eventURI,
                                                             java.lang.String etag)

returns a dataset of the (message) event with the specified URI, with a value that can be used for an etag. If the current etag is the same as the specified one, the dataset is null, indicating no change.

Parameters:

eventURI -

getUnreadInformationForNeed

org.apache.jena.rdf.model.Model getUnreadInformationForNeed(java.net.URI needURI,
                                                            java.util.Collection<java.net.URI> lastSeenMessageURIs)

Returns a model specifying the number of messages and their latest and earliest timestamp found per connection after the specified lastSeenMessageURI, or the total message count and respective timestamps for a connection for which no lastSeenMessageURI is specified.

Parameters:

needURI -

lastSeenMessageURIs -

Returns: