fr.inria.lille.shexjava.schema

Class ShexSchema

java.lang.Object

fr.inria.lille.shexjava.schema.ShexSchema

@ApiStability.Stable
public class ShexSchema
extends Object

A ShEx schema. An instance of this class represents a well-defined schema, that is, all shape labels are defined, there are no circular dependences between ShapeExprRef or TripleExprRef, and the set of rules is stratified. The set of rules is not modifiable after construction. All ShapeExpr and TripleExpr in the constructed schema have a Label, allowing to refer to the corresponding expression. The stratification is a most refined stratification.

Author:

Iovka Boneva, Antonin Durey, Jérémie Dusart

Constructor Summary

Constructors

Constructor and Description
ShexSchema(Map<Label,ShapeExpr> rules) Constructs a ShEx schema whenever the set of rules defines a well-defined schema.
ShexSchema(Map<Label,ShapeExpr> rules, ShapeExpr start) Constructs a ShEx schema whenever the set of rules defines a well-defined schema.
ShexSchema(org.apache.commons.rdf.api.RDF rdfFactory, Map<Label,ShapeExpr> rules) Constructs a ShEx schema whenever the set of rules defines a well-defined schema.
ShexSchema(org.apache.commons.rdf.api.RDF rdfFactory, Map<Label,ShapeExpr> rules, ShapeExpr start)

Method Summary

Modifier and Type	Method and Description
Set<Label>	getLabelsAtStratum(int i) Deprecated. Use getStratification() instead
int	getNbStratums() Deprecated. Use getStratification() instead
org.apache.commons.rdf.api.RDF	getRdfFactory()
Map<Label,ShapeExpr>	getRules() The rules of the schema.
Map<Label,ShapeExpr>	getShapeExprsMap() All the shape expressions that appear in the schema indexed by their label.
ShapeExpr	getStart() Return the start shapeExpr.
Map<Integer,Set<Label>>	getStratification()
int	getStratum(Label label) Deprecated. Use getStratification() instead
Map<Label,TripleExpr>	getTripleExprsMap() All the triple expressions that appear in the schema indexed by their label.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ShexSchema

@ApiStability.Stable
public ShexSchema(Map<Label,ShapeExpr> rules)
                                throws UndefinedReferenceException,
                                       CyclicReferencesException,
                                       NotStratifiedException

Constructs a ShEx schema whenever the set of rules defines a well-defined schema. Otherwise, an exception is thrown. Uses GlobalFactory.RDFFactory for creating the fresh labels.

Parameters:

rules -

Throws:

UndefinedReferenceException

CyclicReferencesException

NotStratifiedException

ShexSchema

public ShexSchema(Map<Label,ShapeExpr> rules,
                  ShapeExpr start)
           throws UndefinedReferenceException,
                  CyclicReferencesException,
                  NotStratifiedException

Constructs a ShEx schema whenever the set of rules defines a well-defined schema. Otherwise, an exception is thrown. Uses GlobalFactory.RDFFactory for creating the fresh labels.

Parameters:

rules -

start -

Throws:

UndefinedReferenceException

CyclicReferencesException

NotStratifiedException

ShexSchema

public ShexSchema(org.apache.commons.rdf.api.RDF rdfFactory,
                  Map<Label,ShapeExpr> rules)
           throws UndefinedReferenceException,
                  CyclicReferencesException,
                  NotStratifiedException

Constructs a ShEx schema whenever the set of rules defines a well-defined schema. Otherwise, an exception is thrown. Allows to specify the factory to be used for creating the fresh labels.

Parameters:

rules -

rdfFactory -

Throws:

UndefinedReferenceException

CyclicReferencesException

NotStratifiedException

ShexSchema

public ShexSchema(org.apache.commons.rdf.api.RDF rdfFactory,
                  Map<Label,ShapeExpr> rules,
                  ShapeExpr start)
           throws UndefinedReferenceException,
                  CyclicReferencesException,
                  NotStratifiedException

Throws:

UndefinedReferenceException

CyclicReferencesException

NotStratifiedException

Method Detail

getRules

@ApiStability.Stable
public Map<Label,ShapeExpr> getRules()

The rules of the schema.

Returns:

the rules of the schema.

getStratification

@ApiStability.Stable
public Map<Integer,Set<Label>> getStratification()

getShapeExprsMap

public Map<Label,ShapeExpr> getShapeExprsMap()

All the shape expressions that appear in the schema indexed by their label.

getTripleExprsMap

public Map<Label,TripleExpr> getTripleExprsMap()

All the triple expressions that appear in the schema indexed by their label.

getStart

public ShapeExpr getStart()

Return the start shapeExpr.

getLabelsAtStratum

@Deprecated
public Set<Label> getLabelsAtStratum(int i)

Deprecated. Use getStratification() instead

The set of shape labels that are on a given stratum.

Parameters:

i -

Returns:

the labels of the shapes on stratum i

getNbStratums

@Deprecated
public int getNbStratums()

Deprecated. Use getStratification() instead

Get the number of stratums of the schema.

getStratum

@Deprecated
public int getStratum(Label label)

Deprecated. Use getStratification() instead

The stratum of a given label.

Parameters:

label -

Returns:

getRdfFactory

public org.apache.commons.rdf.api.RDF getRdfFactory()

toString

public String toString()

Overrides:

toString in class Object