won.protocol.util

Class AtomModelWrapper

java.lang.Object

won.protocol.util.AtomModelWrapper

Direct Known Subclasses:

DefaultAtomModelWrapper

public class AtomModelWrapper
extends java.lang.Object

This class wraps the atom models (atom and sysinfo graphs in an atom dataset). It provides abstraction for the atom structure of is/seeks content nodes that are part of the atom model. It can be used to load and query an existing atom dataset (or models). Furthermore it can be used to create an atom model by adding triples.

Created by hfriedrich on 16.03.2017.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.jena.query.Dataset	atomDataset

Constructor Summary

Constructors

Constructor and Description
AtomModelWrapper(org.apache.jena.query.Dataset ds) Load an atom dataset and extract the atom and sysinfo models from it
AtomModelWrapper(org.apache.jena.query.Dataset ds, boolean addDefaultGraphs) Load an atom dataset and extract the atom and sysinfo models from it
AtomModelWrapper(org.apache.jena.rdf.model.Model atomModel, org.apache.jena.rdf.model.Model sysInfoModel) Load the atom and sysinfo models, if one of these models is null then initialize the other one as default model
AtomModelWrapper(java.lang.String atomUri) Create a new atom model (incluing sysinfo)
AtomModelWrapper(java.net.URI atomUri) Create a new atom model (incluing sysinfo)

Method Summary

Modifier and Type	Method and Description
void	addFlag(org.apache.jena.rdf.model.Resource flag)
void	addMatchingContext(java.lang.String context)
void	addPropertyStringValue(org.apache.jena.rdf.model.Property p, java.lang.String value) Adds a property directly into the contentNode of the atom
void	addQuery(java.lang.String query)
void	addSeeksPropertyStringValue(org.apache.jena.rdf.model.Property p, java.lang.String value)
void	addSocket(java.lang.String socketUri, java.lang.String socketTypeUri) Add a socket.
org.apache.jena.rdf.model.Model	copyAtomModel(AtomGraphType graph) get the atom or sysinfo model
org.apache.jena.query.Dataset	copyDataset() get the complete dataset
org.apache.jena.rdf.model.Resource	createGoalNode(java.lang.String uri) create a goal content node below the atom node of the atom model.
org.apache.jena.rdf.model.Resource	createSeeksNode(java.lang.String uri) create a goal content node below the atom node of the atom model.
boolean	flag(org.apache.jena.rdf.model.Resource flag)
java.util.Collection<org.apache.jena.rdf.model.Resource>	getAllContentNodes() get all seeks, seeks_seeks node including the resource for the atomcontent itself (former is-node)
java.util.Collection<java.lang.String>	getAllContentPropertyStringValues(org.apache.jena.rdf.model.Property p, java.lang.String language)
org.apache.jena.rdf.model.Resource	getAtomContentNode() get the content node of the atom
java.lang.String	getAtomContentPropertyStringValue(org.apache.jena.rdf.model.Property p, java.lang.String... preferredLanguages) Returns one of the possibly many specified values.
org.apache.jena.rdf.model.Model	getAtomModel()
protected org.apache.jena.rdf.model.Resource	getAtomNode(AtomGraphType graph) get the node of the atom of either the atom model or the sysinfo model
AtomState	getAtomState()
java.lang.String	getAtomUri()
java.lang.String	getConnectionContainerUri()
java.util.Collection<org.apache.jena.rdf.model.RDFNode>	getContentPropertyObjects(org.apache.jena.rdf.model.Property p)
java.util.Collection<org.apache.jena.rdf.model.RDFNode>	getContentPropertyObjects(org.apache.jena.rdf.model.Resource contentNode, org.apache.jena.rdf.model.Property p)
java.lang.String	getContentPropertyStringValue(org.apache.jena.rdf.model.Property p)
java.lang.String	getContentPropertyStringValue(org.apache.jena.rdf.model.Resource contentNode, org.apache.jena.rdf.model.Property p)
java.lang.String	getContentPropertyStringValue(java.lang.String propertyPath)
java.util.Collection<java.lang.String>	getContentPropertyStringValues(org.apache.jena.rdf.model.Property p, java.lang.String language)
java.util.Collection<java.lang.String>	getContentPropertyStringValues(org.apache.jena.rdf.model.Resource contentNode, org.apache.jena.rdf.model.Property p, java.lang.String language)
java.time.ZonedDateTime	getCreationDate()
org.apache.jena.rdf.model.Model	getDataGraph(org.apache.jena.rdf.model.Resource goalNode)
java.lang.String	getDataGraphName(org.apache.jena.rdf.model.Resource goalNode)
java.util.Optional<java.lang.String>	getDefaultSocket()
java.util.Optional<org.apache.jena.rdf.model.Model>	getDerivedModel()
java.util.Calendar	getDoNotMatchAfter()
java.util.Calendar	getDoNotMatchBefore()
org.apache.jena.rdf.model.Resource	getGoal(java.lang.String uri)
java.util.Collection<org.apache.jena.rdf.model.Resource>	getGoalNodes()
java.util.Collection<org.apache.jena.rdf.model.Resource>	getGoals()
java.util.Collection<java.lang.String>	getMatchingContexts()
java.time.ZonedDateTime	getModifiedDate()
java.util.Optional<java.lang.String>	getQuery()
java.util.Collection<org.apache.jena.rdf.model.Resource>	getSeeksNodes() get all content nodes of a specified type
java.util.Collection<org.apache.jena.rdf.model.RDFNode>	getSeeksPropertyObjects(org.apache.jena.rdf.model.Property p)
java.util.Collection<java.lang.String>	getSeeksPropertyStringValues(org.apache.jena.rdf.model.Property p)
java.util.Collection<java.lang.String>	getSeeksPropertyStringValues(org.apache.jena.rdf.model.Property p, java.lang.String language)
java.util.Collection<org.apache.jena.rdf.model.Resource>	getSeeksSeeksNodes() get all content nodes of a specified type
org.apache.jena.rdf.model.Model	getShapesGraph(org.apache.jena.rdf.model.Resource goalNode)
java.lang.String	getShapesGraphName(org.apache.jena.rdf.model.Resource goalNode)
java.util.Optional<java.lang.String>	getSocketType(java.lang.String socketUri)
java.util.Collection<java.lang.String>	getSocketUris()
java.lang.String	getSomeContentPropertyStringValue(org.apache.jena.rdf.model.Property p, java.lang.String... preferredLanguages) Returns one of the possibly many specified values.
java.lang.String	getSomeContentPropertyStringValue(org.apache.jena.rdf.model.Resource contentNode, org.apache.jena.rdf.model.Property p) Returns one of the possibly many specified values.
java.lang.String	getSomeContentPropertyStringValue(org.apache.jena.rdf.model.Resource contentNode, org.apache.jena.rdf.model.Property p, java.lang.String... preferredLanguages) Returns one of the possibly many specified values.
org.apache.jena.rdf.model.Model	getSysInfoModel()
java.lang.String	getWonNodeUri()
boolean	hasDerivedModel()
static boolean	isAAtom(org.apache.jena.query.Dataset ds) Indicates if the wrapped data looks like atom data.
boolean	matchingContext(java.lang.String context)
org.apache.jena.rdf.model.Model	normalizeAtomModel() Returns a copy of the model in which no node reachable from the atom node has multiple incoming edges (unless the graph contains a circle, see below).
void	setAtomState(AtomState state)
void	setConnectionContainerUri(java.lang.String containerUri)
void	setContentPropertyStringValue(org.apache.jena.rdf.model.Property p, java.lang.String value)
void	setDefaultSocket(java.lang.String socketUri)
void	setSeeksPropertyStringValue(org.apache.jena.rdf.model.Property p, java.lang.String value)
void	setWonNodeUri(java.lang.String nodeUri)
boolean	sparqlQuery()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

atomDataset

protected org.apache.jena.query.Dataset atomDataset

Constructor Detail

AtomModelWrapper

public AtomModelWrapper(java.net.URI atomUri)

Create a new atom model (incluing sysinfo)

Parameters:

atomUri - atom uri to create the atom models for

AtomModelWrapper

public AtomModelWrapper(java.lang.String atomUri)

Create a new atom model (incluing sysinfo)

Parameters:

atomUri - atom uri to create the atom models for

AtomModelWrapper

public AtomModelWrapper(org.apache.jena.query.Dataset ds)

Load an atom dataset and extract the atom and sysinfo models from it

Parameters:

ds - atom dataset to load

AtomModelWrapper

public AtomModelWrapper(org.apache.jena.query.Dataset ds,
                        boolean addDefaultGraphs)

Load an atom dataset and extract the atom and sysinfo models from it

Parameters:

ds - atom dataset to load

addDefaultGraphs - if this is set to true an atomModelGraph and a sysInfoGraph will be added to the dataset

AtomModelWrapper

public AtomModelWrapper(org.apache.jena.rdf.model.Model atomModel,
                        org.apache.jena.rdf.model.Model sysInfoModel)

Load the atom and sysinfo models, if one of these models is null then initialize the other one as default model

Parameters:

atomModel -

sysInfoModel -

Method Detail

isAAtom

public static boolean isAAtom(org.apache.jena.query.Dataset ds)

Indicates if the wrapped data looks like atom data.

Returns:

getAtomModel

public org.apache.jena.rdf.model.Model getAtomModel()

getSysInfoModel

public org.apache.jena.rdf.model.Model getSysInfoModel()

hasDerivedModel

public boolean hasDerivedModel()

getDerivedModel

public java.util.Optional<org.apache.jena.rdf.model.Model> getDerivedModel()

copyAtomModel

public org.apache.jena.rdf.model.Model copyAtomModel(AtomGraphType graph)

get the atom or sysinfo model

Parameters:

graph - type specifies the atom or sysinfo model to return

Returns:

atom or sysinfo model

copyDataset

public org.apache.jena.query.Dataset copyDataset()

get the complete dataset

Returns:

copy of atomDataset

getAtomNode

protected org.apache.jena.rdf.model.Resource getAtomNode(AtomGraphType graph)

get the node of the atom of either the atom model or the sysinfo model

Parameters:

graph - type specifies the atom or sysinfo atom node to return

Returns:

atom or sysinfo atom node

getAtomContentNode

public org.apache.jena.rdf.model.Resource getAtomContentNode()

get the content node of the atom

Returns:

getAtomUri

public java.lang.String getAtomUri()

addFlag

public void addFlag(org.apache.jena.rdf.model.Resource flag)

flag

public boolean flag(org.apache.jena.rdf.model.Resource flag)

getDoNotMatchBefore

public java.util.Calendar getDoNotMatchBefore()

getDoNotMatchAfter

public java.util.Calendar getDoNotMatchAfter()

addMatchingContext

public void addMatchingContext(java.lang.String context)

matchingContext

public boolean matchingContext(java.lang.String context)

addQuery

public void addQuery(java.lang.String query)

getQuery

public java.util.Optional<java.lang.String> getQuery()

sparqlQuery

public boolean sparqlQuery()

getMatchingContexts

public java.util.Collection<java.lang.String> getMatchingContexts()

addSocket

public void addSocket(java.lang.String socketUri,
                      java.lang.String socketTypeUri)

Add a socket. The socketURI must be a fragment URI off the atom URI, i.e. [atomuri]#socketid, or it is just a fragment identifier, which will be interpreted relative to the atomURI, i.e. #socketid -> [atomuri]#socketid.

Parameters:

socketUri - uniquely identifies this socket of this atom

socketTypeUri - the type of the socket, e.g. won:ChatSocket

setDefaultSocket

public void setDefaultSocket(java.lang.String socketUri)

getDefaultSocket

public java.util.Optional<java.lang.String> getDefaultSocket()

getSocketUris

public java.util.Collection<java.lang.String> getSocketUris()

getSocketType

public java.util.Optional<java.lang.String> getSocketType(java.lang.String socketUri)

getGoals

public java.util.Collection<org.apache.jena.rdf.model.Resource> getGoals()

getGoal

public org.apache.jena.rdf.model.Resource getGoal(java.lang.String uri)

getShapesGraph

public org.apache.jena.rdf.model.Model getShapesGraph(org.apache.jena.rdf.model.Resource goalNode)

getShapesGraphName

public java.lang.String getShapesGraphName(org.apache.jena.rdf.model.Resource goalNode)

getDataGraph

public org.apache.jena.rdf.model.Model getDataGraph(org.apache.jena.rdf.model.Resource goalNode)

getDataGraphName

public java.lang.String getDataGraphName(org.apache.jena.rdf.model.Resource goalNode)

setAtomState

public void setAtomState(AtomState state)

getAtomState

public AtomState getAtomState()

getCreationDate

public java.time.ZonedDateTime getCreationDate()

getModifiedDate

public java.time.ZonedDateTime getModifiedDate()

setConnectionContainerUri

public void setConnectionContainerUri(java.lang.String containerUri)

getConnectionContainerUri

public java.lang.String getConnectionContainerUri()

setWonNodeUri

public void setWonNodeUri(java.lang.String nodeUri)

getWonNodeUri

public java.lang.String getWonNodeUri()

createGoalNode

public org.apache.jena.rdf.model.Resource createGoalNode(java.lang.String uri)

create a goal content node below the atom node of the atom model.

Parameters:

uri - uri of the content node, if null then create blank node

Returns:

content node created

createSeeksNode

public org.apache.jena.rdf.model.Resource createSeeksNode(java.lang.String uri)

create a goal content node below the atom node of the atom model.

Parameters:

uri - uri of the content node, if null then create blank node

Returns:

content node created

getGoalNodes

public java.util.Collection<org.apache.jena.rdf.model.Resource> getGoalNodes()

getSeeksNodes

public java.util.Collection<org.apache.jena.rdf.model.Resource> getSeeksNodes()

get all content nodes of a specified type

Parameters:

type - specifies which content nodes to return (IS, SEEKS, ALL, ...)

Returns:

content nodes

getAllContentNodes

public java.util.Collection<org.apache.jena.rdf.model.Resource> getAllContentNodes()

get all seeks, seeks_seeks node including the resource for the atomcontent itself (former is-node)

Returns:

content nodes

getSeeksSeeksNodes

public java.util.Collection<org.apache.jena.rdf.model.Resource> getSeeksSeeksNodes()

get all content nodes of a specified type

Parameters:

type - specifies which content nodes to return (IS, SEEKS, ALL, ...)

Returns:

content nodes

setContentPropertyStringValue

public void setContentPropertyStringValue(org.apache.jena.rdf.model.Property p,
                                          java.lang.String value)

setSeeksPropertyStringValue

public void setSeeksPropertyStringValue(org.apache.jena.rdf.model.Property p,
                                        java.lang.String value)

addPropertyStringValue

public void addPropertyStringValue(org.apache.jena.rdf.model.Property p,
                                   java.lang.String value)

Adds a property directly into the contentNode of the atom

Parameters:

p -

value -

addSeeksPropertyStringValue

public void addSeeksPropertyStringValue(org.apache.jena.rdf.model.Property p,
                                        java.lang.String value)

getContentPropertyStringValue

public java.lang.String getContentPropertyStringValue(org.apache.jena.rdf.model.Resource contentNode,
                                                      org.apache.jena.rdf.model.Property p)

getContentPropertyStringValue

public java.lang.String getContentPropertyStringValue(org.apache.jena.rdf.model.Property p)

getContentPropertyStringValue

public java.lang.String getContentPropertyStringValue(java.lang.String propertyPath)

getContentPropertyStringValues

public java.util.Collection<java.lang.String> getContentPropertyStringValues(org.apache.jena.rdf.model.Resource contentNode,
                                                                             org.apache.jena.rdf.model.Property p,
                                                                             java.lang.String language)

getContentPropertyObjects

public java.util.Collection<org.apache.jena.rdf.model.RDFNode> getContentPropertyObjects(org.apache.jena.rdf.model.Resource contentNode,
                                                                                         org.apache.jena.rdf.model.Property p)

getAllContentPropertyStringValues

public java.util.Collection<java.lang.String> getAllContentPropertyStringValues(org.apache.jena.rdf.model.Property p,
                                                                                java.lang.String language)

getContentPropertyStringValues

public java.util.Collection<java.lang.String> getContentPropertyStringValues(org.apache.jena.rdf.model.Property p,
                                                                             java.lang.String language)

getSeeksPropertyStringValues

public java.util.Collection<java.lang.String> getSeeksPropertyStringValues(org.apache.jena.rdf.model.Property p)

getSeeksPropertyStringValues

public java.util.Collection<java.lang.String> getSeeksPropertyStringValues(org.apache.jena.rdf.model.Property p,
                                                                           java.lang.String language)

getSeeksPropertyObjects

public java.util.Collection<org.apache.jena.rdf.model.RDFNode> getSeeksPropertyObjects(org.apache.jena.rdf.model.Property p)

getSomeContentPropertyStringValue

public java.lang.String getSomeContentPropertyStringValue(org.apache.jena.rdf.model.Resource contentNode,
                                                          org.apache.jena.rdf.model.Property p)

Returns one of the possibly many specified values. The specified preferred languages will be tried first in the specified order.

Parameters:

contentNode -

Returns:

the string value or null if nothing is found

getSomeContentPropertyStringValue

public java.lang.String getSomeContentPropertyStringValue(org.apache.jena.rdf.model.Resource contentNode,
                                                          org.apache.jena.rdf.model.Property p,
                                                          java.lang.String... preferredLanguages)

Returns one of the possibly many specified values. The specified preferred languages will be tried first in the specified order.

Parameters:

contentNode -

preferredLanguages - String array of a non-empty language tag as defined by https://tools.ietf.org/html/bcp47. The language tag must be well-formed according to section 2.2.9 of https://tools.ietf.org/html/bcp47.

Returns:

the string value or null if nothing is found

getSomeContentPropertyStringValue

public java.lang.String getSomeContentPropertyStringValue(org.apache.jena.rdf.model.Property p,
                                                          java.lang.String... preferredLanguages)

Returns one of the possibly many specified values. The specified preferred languages will be tried first in the specified order.

Parameters:

preferredLanguages - String array of a non-empty language tag as defined by https://tools.ietf.org/html/bcp47. The language tag must be well-formed according to section 2.2.9 of https://tools.ietf.org/html/bcp47.

Returns:

the string value or null if nothing is found

getAtomContentPropertyStringValue

public java.lang.String getAtomContentPropertyStringValue(org.apache.jena.rdf.model.Property p,
                                                          java.lang.String... preferredLanguages)

Returns one of the possibly many specified values. The specified preferred languages will be tried first in the specified order.

Parameters:

preferredLanguages - String array of a non-empty language tag as defined by https://tools.ietf.org/html/bcp47. The language tag must be well-formed according to section 2.2.9 of https://tools.ietf.org/html/bcp47.

Returns:

the string value or null if nothing is found

getContentPropertyObjects

public java.util.Collection<org.apache.jena.rdf.model.RDFNode> getContentPropertyObjects(org.apache.jena.rdf.model.Property p)

normalizeAtomModel

public org.apache.jena.rdf.model.Model normalizeAtomModel()

Returns a copy of the model in which no node reachable from the atom node has multiple incoming edges (unless the graph contains a circle, see below). This is achieved by making copies of all nodes that have multiple incoming edges, such that each copy and the original get one of the incoming edges. The outgoing edges of the original are replicated in the copies. Nodes that were newly introduced by this algorithm are never split. In that special case that the graph contains a circle, the resulting graph still contains a circle, and possibly one or more nodes with more than one incoming edge.

Returns: