won.protocol.util

Class NeedModelWrapper

java.lang.Object

won.protocol.util.NeedModelWrapper

Direct Known Subclasses:

DefaultNeedModelWrapper

public class NeedModelWrapper
extends java.lang.Object

This class wraps the need models (need and sysinfo graphs in a need dataset). It provides abstraction for the need structure of is/seeks content nodes that are part of the need model. It can be used to load and query an existing need dataset (or models). Furthermore it can be used to create a need 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	needDataset

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addContentPropertyStringValue(NeedContentPropertyType type, org.apache.jena.rdf.model.Property p, java.lang.String value)
void	addFacetUri(java.lang.String facetUri)
void	addFlag(org.apache.jena.rdf.model.Resource flag)
void	addMatchingContext(java.lang.String context)
org.apache.jena.query.Dataset	copyDataset() get the complete dataset
org.apache.jena.rdf.model.Model	copyNeedModel(NeedGraphType graph) get the need or sysinfo model
org.apache.jena.rdf.model.Resource	createContentNode(NeedContentPropertyType type, java.lang.String uri) create a content node below the need node of the need model.
java.lang.String	getConnectionContainerUri()
java.util.Collection<org.apache.jena.rdf.model.Resource>	getContentNodes(NeedContentPropertyType type) get all content nodes of a specified type
java.lang.String	getContentPropertyStringValue(NeedContentPropertyType type, org.apache.jena.rdf.model.Property p)
java.lang.String	getContentPropertyStringValue(NeedContentPropertyType type, java.lang.String propertyPath)
java.lang.String	getContentPropertyStringValue(org.apache.jena.rdf.model.Resource contentNode, org.apache.jena.rdf.model.Property p)
java.util.Collection<java.lang.String>	getContentPropertyStringValues(NeedContentPropertyType type, 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)
NeedContentPropertyType	getContentPropertyType(org.apache.jena.rdf.model.Resource contentNode)
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.Collection<java.lang.String>	getFacetUris()
org.apache.jena.rdf.model.Resource	getGoal(java.lang.String uri)
java.util.Collection<org.apache.jena.rdf.model.Resource>	getGoals()
java.util.Collection<java.lang.String>	getMatchingContexts()
org.apache.jena.rdf.model.Model	getNeedModel()
protected org.apache.jena.rdf.model.Resource	getNeedNode(NeedGraphType graph) get the node of the need of either the need model or the sysinfo model
NeedState	getNeedState()
java.lang.String	getNeedUri()
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.lang.String	getSomeContentPropertyStringValue(NeedContentPropertyType type, 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	hasFlag(org.apache.jena.rdf.model.Resource flag)
boolean	hasMatchingContext(java.lang.String context)
static boolean	isANeed(org.apache.jena.query.Dataset ds) Indicates if the wrapped data looks like need data.
org.apache.jena.rdf.model.Model	normalizeNeedModel() Returns a copy of the model in which no node reachable from the need node has multiple incoming edges (unless the graph contains a circle, see below).
void	setConnectionContainerUri(java.lang.String containerUri)
void	setContentPropertyStringValue(NeedContentPropertyType type, org.apache.jena.rdf.model.Property p, java.lang.String value)
void	setNeedState(NeedState state)
void	setWonNodeUri(java.lang.String nodeUri)

Methods inherited from class java.lang.Object

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

Field Detail

needDataset

protected org.apache.jena.query.Dataset needDataset

Constructor Detail

NeedModelWrapper

public NeedModelWrapper(java.lang.String needUri)

Create a new need model (incluing sysinfo)

Parameters:

needUri - need uri to create the need models for

NeedModelWrapper

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

Load a need dataset and extract the need and sysinfo models from it

Parameters:

ds - need dataset to load

NeedModelWrapper

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

Load a need dataset and extract the need and sysinfo models from it

Parameters:

ds - need dataset to load

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

NeedModelWrapper

public NeedModelWrapper(org.apache.jena.rdf.model.Model needModel,
                        org.apache.jena.rdf.model.Model sysInfoModel)

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

Parameters:

needModel -

sysInfoModel -

Method Detail

isANeed

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

Indicates if the wrapped data looks like need data.

Returns:

getNeedModel

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

getSysInfoModel

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

copyNeedModel

public org.apache.jena.rdf.model.Model copyNeedModel(NeedGraphType graph)

get the need or sysinfo model

Parameters:

graph - type specifies the need or sysinfo model to return

Returns:

need or sysinfo model

copyDataset

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

get the complete dataset

Returns:

copy of needDataset

getNeedNode

protected org.apache.jena.rdf.model.Resource getNeedNode(NeedGraphType graph)

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

Parameters:

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

Returns:

need or sysinfo need node

getNeedUri

public java.lang.String getNeedUri()

addFlag

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

hasFlag

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

addMatchingContext

public void addMatchingContext(java.lang.String context)

hasMatchingContext

public boolean hasMatchingContext(java.lang.String context)

getMatchingContexts

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

addFacetUri

public void addFacetUri(java.lang.String facetUri)

getFacetUris

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

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)

setNeedState

public void setNeedState(NeedState state)

getNeedState

public NeedState getNeedState()

getCreationDate

public java.time.ZonedDateTime getCreationDate()

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()

createContentNode

public org.apache.jena.rdf.model.Resource createContentNode(NeedContentPropertyType type,
                                                            java.lang.String uri)

create a content node below the need node of the need model.

Parameters:

type - specifies which property (e.g. IS, SEEKS, ...) is used to connect the need node with the content node

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

Returns:

content node created

getContentPropertyType

public NeedContentPropertyType getContentPropertyType(org.apache.jena.rdf.model.Resource contentNode)

getContentNodes

public java.util.Collection<org.apache.jena.rdf.model.Resource> getContentNodes(NeedContentPropertyType type)

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(NeedContentPropertyType type,
                                          org.apache.jena.rdf.model.Property p,
                                          java.lang.String value)

addContentPropertyStringValue

public void addContentPropertyStringValue(NeedContentPropertyType type,
                                          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(NeedContentPropertyType type,
                                                      org.apache.jena.rdf.model.Property p)

getContentPropertyStringValue

public java.lang.String getContentPropertyStringValue(NeedContentPropertyType type,
                                                      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)

getContentPropertyStringValues

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

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(NeedContentPropertyType type,
                                                          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

normalizeNeedModel

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

Returns a copy of the model in which no node reachable from the need 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: