won.protocol.service

Interface LinkedDataService

public interface LinkedDataService

User: fkleedorfer Date: 26.11.12

Method Summary

Modifier and Type	Method and Description
org.apache.jena.query.Dataset	getAtomDataset(java.net.URI atomUri, boolean deep, java.lang.Integer deepLayerSize) Returns a dataset describing the atom with the specified URI.
DataWithEtag<org.apache.jena.query.Dataset>	getAtomDataset(java.net.URI atomUri, java.lang.String etag) Returns a dataset describing the atom, if the etag indicates that it has changed.
DataWithEtag<org.apache.jena.query.Dataset>	getConnectionDataset(java.net.URI connectionUri, boolean includeMessageContainer, 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	getNodeDataset()
org.apache.jena.rdf.model.Model	getUnreadInformationForAtom(java.net.URI atomURI, 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	listAtomURIs() Returns a model containing all atom URIs.
AtomInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI>	listAtomURIs(int page) Returns a model containing all atom URIs.
AtomInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI>	listAtomURIs(int page, java.lang.Integer preferedSize, AtomState atomState) Returns a model containing all atom URIs that are in the specified state.
AtomInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI>	listAtomURIsAfter(java.net.URI atom) Return all atom URIs that where created after the provided atom
AtomInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI>	listAtomURIsAfter(java.net.URI atom, java.lang.Integer preferedSize, AtomState atomState) Return all atom URIs that where created after the provided atom and that are in the specified state
AtomInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI>	listAtomURIsBefore(java.net.URI atom) Return all atom URIs that where created before the provided atom
AtomInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI>	listAtomURIsBefore(java.net.URI atom, java.lang.Integer preferedSize, AtomState atomState) Return all atom URIs that where created after the provided atom and that are in the specified state
org.apache.jena.query.Dataset	listConnectionEventURIs(java.net.URI connectionUri, boolean deep) Returns a dataset containing all event uris belonging to the specified connection.
AtomInformationService.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.
AtomInformationService.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.
AtomInformationService.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.
AtomInformationService.PagedResource<org.apache.jena.query.Dataset,Connection>	listConnections(boolean deep) Returns container dataset containing all connections.
AtomInformationService.PagedResource<org.apache.jena.query.Dataset,Connection>	listConnections(int page, java.lang.Integer preferredSize, java.util.Date timeSpot, boolean deep) Returns a resource containing connections at given page.
AtomInformationService.PagedResource<org.apache.jena.query.Dataset,Connection>	listConnections(int page, java.net.URI atomURI, java.lang.Integer preferredSize, WonMessageType messageType, java.util.Date timeSpot, boolean deep, boolean addMetadata) Returns paged resource containing all connections belonging to the specified atom.
AtomInformationService.PagedResource<org.apache.jena.query.Dataset,Connection>	listConnections(java.net.URI atomURI, boolean deep, boolean addMetadata) Returns a model containing all connection uris belonging to the specified atom.
AtomInformationService.PagedResource<org.apache.jena.query.Dataset,Connection>	listConnectionsAfter(java.net.URI afterConnURI, java.lang.Integer preferredSize, java.util.Date timeSpot, boolean deep) Returns a resource containing connections that follow (by time of their latest event activities) the given connection as of state that was at the specified time.
AtomInformationService.PagedResource<org.apache.jena.query.Dataset,Connection>	listConnectionsAfter(java.net.URI atomURI, java.net.URI resumeConnURI, java.lang.Integer preferredSize, WonMessageType messageType, java.util.Date timeSpot, boolean deep, boolean addMetadata) Returns paged resource containing all connections belonging to the specified atom that follows the given connection URI from the point of view of their latest events.
AtomInformationService.PagedResource<org.apache.jena.query.Dataset,Connection>	listConnectionsBefore(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.
AtomInformationService.PagedResource<org.apache.jena.query.Dataset,Connection>	listConnectionsBefore(java.net.URI atomURI, java.net.URI resumeConnURI, java.lang.Integer preferredSize, WonMessageType messageType, java.util.Date timeSpot, boolean deep, boolean addMetadata) Returns paged resource containing all connections belonging to the specified atom that precede the given connection URI from the point of view of their latest events.
org.apache.jena.query.Dataset	listModifiedAtomURIsAfter(java.util.Date modifiedDate) Returns container dataset containing all atoms that have been modified after a certain date
AtomInformationService.PagedResource<org.apache.jena.query.Dataset,Connection>	listModifiedConnectionsAfter(java.util.Date modifiedAfter, boolean deep) Returns container dataset containing all connection URIs that where modified after a certain date.

Method Detail

listAtomURIs

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

Returns a model containing all atom URIs.

Returns:

listAtomURIs

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

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

Parameters:

page -

Returns:

listAtomURIs

AtomInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI> listAtomURIs(int page,
                                                                                              java.lang.Integer preferedSize,
                                                                                              AtomState atomState)

Returns a model containing all atom 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 atom uris per page (null means use default)

atomState -

Returns:

listAtomURIsBefore

AtomInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI> listAtomURIsBefore(java.net.URI atom)

Return all atom URIs that where created before the provided atom

Parameters:

atom -

Returns:

listAtomURIsAfter

AtomInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI> listAtomURIsAfter(java.net.URI atom)

Return all atom URIs that where created after the provided atom

Parameters:

atom -

Returns:

listAtomURIsBefore

AtomInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI> listAtomURIsBefore(java.net.URI atom,
                                                                                                    java.lang.Integer preferedSize,
                                                                                                    AtomState atomState)

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

Parameters:

atom -

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

atomState -

Returns:

listAtomURIsAfter

AtomInformationService.PagedResource<org.apache.jena.query.Dataset,java.net.URI> listAtomURIsAfter(java.net.URI atom,
                                                                                                   java.lang.Integer preferedSize,
                                                                                                   AtomState atomState)

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

Parameters:

atom -

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

atomState -

Returns:

listModifiedAtomURIsAfter

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

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

Parameters:

modifiedDate - modification date of atoms

Returns:

listConnections

AtomInformationService.PagedResource<org.apache.jena.query.Dataset,Connection> listConnections(boolean deep)
                                                                                        throws NoSuchConnectionException

Returns container dataset containing all connections. 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.

listModifiedConnectionsAfter

AtomInformationService.PagedResource<org.apache.jena.query.Dataset,Connection> listModifiedConnectionsAfter(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

listConnections

AtomInformationService.PagedResource<org.apache.jena.query.Dataset,Connection> listConnections(int page,
                                                                                               java.lang.Integer preferredSize,
                                                                                               java.util.Date timeSpot,
                                                                                               boolean deep)
                                                                                        throws NoSuchConnectionException

Returns a resource containing connections 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:

NoSuchAtomException

NoSuchConnectionException

listConnectionsBefore

AtomInformationService.PagedResource<org.apache.jena.query.Dataset,Connection> listConnectionsBefore(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:

NoSuchAtomException

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

listConnectionsAfter

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

Returns a resource containing connections 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:

NoSuchAtomException

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

listConnections

AtomInformationService.PagedResource<org.apache.jena.query.Dataset,Connection> listConnections(java.net.URI atomURI,
                                                                                               boolean deep,
                                                                                               boolean addMetadata)
                                                                                        throws NoSuchAtomException,
                                                                                               NoSuchConnectionException

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

Parameters:

atomURI -

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:

NoSuchAtomException

NoSuchConnectionException

listConnections

AtomInformationService.PagedResource<org.apache.jena.query.Dataset,Connection> listConnections(int page,
                                                                                               java.net.URI atomURI,
                                                                                               java.lang.Integer preferredSize,
                                                                                               WonMessageType messageType,
                                                                                               java.util.Date timeSpot,
                                                                                               boolean deep,
                                                                                               boolean addMetadata)
                                                                                        throws NoSuchAtomException,
                                                                                               NoSuchConnectionException

Returns paged resource containing all connections belonging to the specified atom.

Parameters:

page - number

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

atomURI - local atom 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:

NoSuchAtomException - when specified atom is not found

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

listConnectionsBefore

AtomInformationService.PagedResource<org.apache.jena.query.Dataset,Connection> listConnectionsBefore(java.net.URI atomURI,
                                                                                                     java.net.URI resumeConnURI,
                                                                                                     java.lang.Integer preferredSize,
                                                                                                     WonMessageType messageType,
                                                                                                     java.util.Date timeSpot,
                                                                                                     boolean deep,
                                                                                                     boolean addMetadata)
                                                                                              throws NoSuchAtomException,
                                                                                                     NoSuchConnectionException

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

Parameters:

atomURI - local atom 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:

NoSuchAtomException - when specified atom is not found

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

listConnectionsAfter

AtomInformationService.PagedResource<org.apache.jena.query.Dataset,Connection> listConnectionsAfter(java.net.URI atomURI,
                                                                                                    java.net.URI resumeConnURI,
                                                                                                    java.lang.Integer preferredSize,
                                                                                                    WonMessageType messageType,
                                                                                                    java.util.Date timeSpot,
                                                                                                    boolean deep,
                                                                                                    boolean addMetadata)
                                                                                             throws NoSuchAtomException,
                                                                                                    NoSuchConnectionException

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

Parameters:

atomURI - local atom 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:

NoSuchAtomException - when specified atom is not found

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

getAtomDataset

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

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

Parameters:

atomUri -

etag -

Returns:

dataset with etag describing the atom or null if not found

getAtomDataset

org.apache.jena.query.Dataset getAtomDataset(java.net.URI atomUri,
                                             boolean deep,
                                             java.lang.Integer deepLayerSize)
                                      throws NoSuchAtomException,
                                             NoSuchConnectionException,
                                             org.springframework.context.NoSuchMessageException

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

Parameters:

atomUri -

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

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

Returns:

Throws:

NoSuchAtomException

NoSuchConnectionException

org.springframework.context.NoSuchMessageException

getConnectionDataset

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

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

Parameters:

connectionUri -

includeMessageContainer -

etag -

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

AtomInformationService.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

AtomInformationService.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

AtomInformationService.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 -

getUnreadInformationForAtom

org.apache.jena.rdf.model.Model getUnreadInformationForAtom(java.net.URI atomURI,
                                                            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:

atomURI -

lastSeenMessageURIs -

Returns: