io.konig.core.showl

Class ShowlNodeShape

java.lang.Object

io.konig.core.showl.ShowlNodeShape

All Implemented Interfaces:

Traversable

public class ShowlNodeShape
extends Object
implements Traversable

A particular instance of a SHACL NodeShape. The instance may be bound to a particular location a SHACL description via a PropertyShape accessor, and it may be bound to a particular DataSource.

T

Author:

Greg McFall

Constructor Summary

Constructors

Constructor and Description
ShowlNodeShape(ShowlManager manager, ShowlPropertyShape accessor, Shape shape, ShowlClass owlClass)
ShowlNodeShape(ShowlPropertyShape accessor, Shape shape, ShowlClass owlClass)

Method Summary

Modifier and Type	Method and Description
void	addChannel(ShowlChannel channel)
void	addDerivedProperty(ShowlDerivedPropertyShape p)
void	addInwardProperty(ShowlInwardPropertyShape p)
void	addProperty(ShowlDirectPropertyShape p)
void	addSelectedJoin(ShowlJoinCondition join)
Set<ShowlPropertyShape>	allOutwardProperties()
ShowlEffectiveNodeShape	effectiveNode()
boolean	encapsulates(ShowlPropertyShape p)
ShowlPropertyShape	enumSourceKey()
ShowlChannel	findChannelFor(ShowlNodeShape node)
ShowlPropertyShape	findOut(org.openrdf.model.URI predicate)
ShowlPropertyShape	findProperty(org.openrdf.model.URI predicate) Deprecated.
ShowlPropertyShape	getAccessor()
List<ShowlChannel>	getChannels()
Collection<ShowlDerivedPropertyList>	getDerivedProperties()
ShowlDerivedPropertyList	getDerivedProperty(org.openrdf.model.URI predicate) Get the list of derived properties having a specified predicate.
ShowlEffectiveNodeShape	getEffectiveNode()
org.openrdf.model.Resource	getId()
Collection<ShowlInwardPropertyShape>	getInwardProperties()
ShowlInwardPropertyShape	getInwardProperty(org.openrdf.model.URI predicate)
ShowlStatement	getJoinStatement() Get the statement used to join this source NodeShape to some other source NodeShape(s)
ShowlNodeShape	getLogicalNodeShape()
NodeKind	getNodeKind()
ShowlClass	getOwlClass()
String	getPath()
Collection<ShowlDirectPropertyShape>	getProperties()
ShowlDirectPropertyShape	getProperty(org.openrdf.model.URI predicate)
ShowlNodeShape	getRoot()
List<ShowlJoinCondition>	getSelectedJoins()
Shape	getShape()
ShowlDataSource	getShapeDataSource()
ShowlManager	getShowlManager()
ShowlNodeShape	getTargetNode() Get the target node to which this source node is mapped.
ShowlPropertyShape	getTargetProperty() Get the property on the target NodeShape to which this source NodeShape is bound.
ShowlUniqueKeyCollection	getUniqueKeyCollection()
boolean	hasAncestor(org.openrdf.model.Resource shapeId)
boolean	hasDataSource()
boolean	isNamedRoot() Deprecated.
boolean	isStaticEnumShape()
boolean	isTargetNode()
Set<ShowlPropertyShape>	joinProperties(ShowlJoinCondition join) Get all the properties mapped to this NodeShape via a given join condition.
Set<ShowlPropertyShape>	joinProperties(ShowlNodeShape otherNode) Get the properties of some otherNode that are reachable from the selected mappings of this NodeShape.
ShowlPropertyShape	keyProperty(ShowlNodeShape sourceNode, ShowlJoinCondition join) Get the key through which the specified source node is joined according to the given join condition.
List<ShowlChannel>	nonEnumChannels(OwlReasoner reasoner)
List<ShowlPropertyShape>	out(org.openrdf.model.URI predicate)
List<ShowlPropertyShape>	path()
List<ShowlPropertyShape>	selectedPropertiesOf(ShowlNodeShape sourceNodeShape) Get all properties from a specified source NodeShape that contribute to the definition of this target NodeShape.
void	setJoinStatement(ShowlStatement joinStatement)
void	setLogicalNodeShape(ShowlNodeShape logicalNodeShape)
void	setOwlClass(ShowlClass owlClass)
void	setShapeDataSource(ShowlDataSource shapeDataSource)
void	setTargetNode(ShowlNodeShape targetNode) Set the target node to which this source node is mapped.
void	setTargetProperty(ShowlPropertyShape targetProperty)
void	setUniqueKeyCollection(ShowlUniqueKeyCollection uniqueKeyCollection)
ShowlStaticPropertyShape	staticProperty(ShowlProperty property)
SynsetNode	synsetNode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ShowlNodeShape

public ShowlNodeShape(ShowlPropertyShape accessor,
                      Shape shape,
                      ShowlClass owlClass)

ShowlNodeShape

public ShowlNodeShape(ShowlManager manager,
                      ShowlPropertyShape accessor,
                      Shape shape,
                      ShowlClass owlClass)

Method Detail

getShowlManager

public ShowlManager getShowlManager()

getEffectiveNode

public ShowlEffectiveNodeShape getEffectiveNode()

synsetNode

public SynsetNode synsetNode()

effectiveNode

public ShowlEffectiveNodeShape effectiveNode()

isStaticEnumShape

public boolean isStaticEnumShape()

keyProperty

public ShowlPropertyShape keyProperty(ShowlNodeShape sourceNode,
                                      ShowlJoinCondition join)

Get the key through which the specified source node is joined according to the given join condition.

Parameters:

sourceNode - The source node whose key is being requested

join - The join condition for the key.

joinProperties

public Set<ShowlPropertyShape> joinProperties(ShowlNodeShape otherNode)
                                       throws ShowlProcessingException

Get the properties of some otherNode that are reachable from the selected mappings of this NodeShape.

Throws:

ShowlProcessingException

joinProperties

public Set<ShowlPropertyShape> joinProperties(ShowlJoinCondition join)
                                       throws ShowlProcessingException

Get all the properties mapped to this NodeShape via a given join condition.

Throws:

ShowlProcessingException

enumSourceKey

public ShowlPropertyShape enumSourceKey()
                                 throws ShowlProcessingException

Throws:

ShowlProcessingException

addInwardProperty

public void addInwardProperty(ShowlInwardPropertyShape p)

getInwardProperty

public ShowlInwardPropertyShape getInwardProperty(org.openrdf.model.URI predicate)

getInwardProperties

public Collection<ShowlInwardPropertyShape> getInwardProperties()

isNamedRoot

@Deprecated
public boolean isNamedRoot()

Deprecated.

getProperties

public Collection<ShowlDirectPropertyShape> getProperties()

allOutwardProperties

public Set<ShowlPropertyShape> allOutwardProperties()

addProperty

public void addProperty(ShowlDirectPropertyShape p)

getProperty

public ShowlDirectPropertyShape getProperty(org.openrdf.model.URI predicate)

getDerivedProperty

public ShowlDerivedPropertyList getDerivedProperty(org.openrdf.model.URI predicate)

Get the list of derived properties having a specified predicate. This is a list because there are multiple ways in which a given property might be derived:

1. Explicit derived property having a formula within the sh:NodeShape
2. Implicit property from some other formula that includes the predicate in a path expression.

In the case where the property is induced from a path expression, a separate entry is required for each path expression that has a filter.

getId

public org.openrdf.model.Resource getId()

getShape

public Shape getShape()

getOwlClass

public ShowlClass getOwlClass()

hasDataSource

public boolean hasDataSource()

setOwlClass

public void setOwlClass(ShowlClass owlClass)

hasAncestor

public boolean hasAncestor(org.openrdf.model.Resource shapeId)

getAccessor

public ShowlPropertyShape getAccessor()

addDerivedProperty

public void addDerivedProperty(ShowlDerivedPropertyShape p)

findOut

public ShowlPropertyShape findOut(org.openrdf.model.URI predicate)

out

public List<ShowlPropertyShape> out(org.openrdf.model.URI predicate)

findProperty

@Deprecated
public ShowlPropertyShape findProperty(org.openrdf.model.URI predicate)

Deprecated.

Find an outward property.

getDerivedProperties

public Collection<ShowlDerivedPropertyList> getDerivedProperties()

getPath

public String getPath()

Specified by:

getPath in interface Traversable

toString

public String toString()

Overrides:

toString in class Object

getRoot

public ShowlNodeShape getRoot()

addSelectedJoin

public void addSelectedJoin(ShowlJoinCondition join)

getSelectedJoins

public List<ShowlJoinCondition> getSelectedJoins()

getNodeKind

public NodeKind getNodeKind()

staticProperty

public ShowlStaticPropertyShape staticProperty(ShowlProperty property)

getShapeDataSource

public ShowlDataSource getShapeDataSource()

setShapeDataSource

public void setShapeDataSource(ShowlDataSource shapeDataSource)

addChannel

public void addChannel(ShowlChannel channel)

nonEnumChannels

public List<ShowlChannel> nonEnumChannels(OwlReasoner reasoner)

getChannels

public List<ShowlChannel> getChannels()

selectedPropertiesOf

public List<ShowlPropertyShape> selectedPropertiesOf(ShowlNodeShape sourceNodeShape)

Get all properties from a specified source NodeShape that contribute to the definition of this target NodeShape. This includes selected properties from the source NodeShape, and properties in any join statements.

getTargetProperty

public ShowlPropertyShape getTargetProperty()

Get the property on the target NodeShape to which this source NodeShape is bound.

setTargetProperty

public void setTargetProperty(ShowlPropertyShape targetProperty)

getLogicalNodeShape

public ShowlNodeShape getLogicalNodeShape()

setLogicalNodeShape

public void setLogicalNodeShape(ShowlNodeShape logicalNodeShape)

getJoinStatement

public ShowlStatement getJoinStatement()

Get the statement used to join this source NodeShape to some other source NodeShape(s)

setJoinStatement

public void setJoinStatement(ShowlStatement joinStatement)

getTargetNode

public ShowlNodeShape getTargetNode()

Get the target node to which this source node is mapped.

Returns:

The target node to which this source node is mapped, or null if this node is a target node.

setTargetNode

public void setTargetNode(ShowlNodeShape targetNode)

Set the target node to which this source node is mapped.

Parameters:

targetNode -

isTargetNode

public boolean isTargetNode()

path

public List<ShowlPropertyShape> path()

encapsulates

public boolean encapsulates(ShowlPropertyShape p)

findChannelFor

public ShowlChannel findChannelFor(ShowlNodeShape node)

getUniqueKeyCollection

public ShowlUniqueKeyCollection getUniqueKeyCollection()

setUniqueKeyCollection

public void setUniqueKeyCollection(ShowlUniqueKeyCollection uniqueKeyCollection)