org.processmining.plugins.ltlchecker

Class OntologyModel

java.lang.Object

org.processmining.plugins.ltlchecker.OntologyModel

public class OntologyModel
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ONTOLOGY_SEPARATOR
static java.util.regex.Pattern	ONTOLOGY_SEPARATOR_PATTERN

Constructor Summary

Constructors

Constructor and Description
OntologyModel(java.lang.String uriInLog, java.util.Map<java.lang.String,java.util.Set<java.lang.String>> instancesPerConcept) Constructor for reading an existing ontology.
OntologyModel(java.lang.String namespace, java.lang.String name) Constructor for a new (empty) ontology.

Method Summary

Modifier and Type	Method and Description
ConceptModel	addConcept(java.lang.String conceptShortName) Adds a new concept with the given name to this ontology.
ConceptModel	findConcept(java.lang.String conceptShortName) Returns the concept with the given short name, or null if no such concept exists in this ontology.
java.util.Collection<ConceptModel>	getAllConcepts() Returns a list of all concepts which are directly referenced in the log, or which are superconcepts of any concept which is directly referenced in the log.
java.util.Collection<ConceptModel>	getAllDirectSubConcepts(ConceptModel concept) Returns a collection of all direct subconcepts, including concepts which are not directly referenced in the log.
java.util.Collection<ConceptModel>	getAllDirectSuperConcepts(ConceptModel concept) Returns a collection of all direct superconcepts, including concepts which are not directly referenced in the log.
static java.lang.String	getConceptPart(java.lang.String uri) Returns the part of the URI after the "#" character.
java.util.Collection<ConceptModel>	getConcepts() Returns a list of all concepts which are directly referenced in the log.
java.lang.String	getConceptURIInLog(ConceptModel c) Returns the model reference of the given concept as it is used in the log.
java.util.Collection<ConceptModel>	getDirectSubConcepts(ConceptModel concept) Returns a collection of the direct subconcepts which are directly referenced in the log.
java.util.Collection<ConceptModel>	getDirectSuperConcepts(ConceptModel concept) Returns a collection of the direct superconcepts which are directly referenced in the log.
java.lang.String	getName() Returns the full URI of the ontology.
static java.lang.String	getOntologyPart(java.lang.String uri) Returns the part of the URI before the "#" character.
java.lang.String	getShortName() Returns the name of the ontology without the full URI path.
java.util.Collection<ConceptModel>	getSubConcepts(ConceptModel concept) Returns a collection of all subconcepts of a given concept.
java.util.Collection<ConceptModel>	getSuperConcepts(ConceptModel concept) Returns a collection of all superconcepts of a given concept.
java.lang.String	getUriInLog() Returns the URI of the file in which the ontology is stored (can be a file or an http URL for example).
boolean	isChanged() Returns true if the ontology model was changed (ie.
java.lang.String	serialize()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ONTOLOGY_SEPARATOR

public static final java.lang.String ONTOLOGY_SEPARATOR

See Also:

Constant Field Values

ONTOLOGY_SEPARATOR_PATTERN

public static final java.util.regex.Pattern ONTOLOGY_SEPARATOR_PATTERN

Constructor Detail

OntologyModel

public OntologyModel(java.lang.String uriInLog,
                     java.util.Map<java.lang.String,java.util.Set<java.lang.String>> instancesPerConcept)
              throws java.io.IOException,
                     org.wsmo.wsml.ParserException,
                     org.wsml.reasoner.api.inconsistency.InconsistencyException,
                     org.wsmo.common.exception.InvalidModelException,
                     org.wsmo.common.exception.InvalidModelException

Constructor for reading an existing ontology.

Parameters:

uriInLog - URI of ontology as it is used in a log file.

instancesPerConcept - Mapping from concept URIs in the log to a set of instance labels.

Throws:

java.io.IOException

org.wsmo.wsml.ParserException

InvalidModelException

org.wsml.reasoner.api.inconsistency.InconsistencyException

InvalidModelException

org.processmining.plugins.ltlchecker.models.ontology.InvalidModelException

org.wsmo.common.exception.InvalidModelException

OntologyModel

public OntologyModel(java.lang.String namespace,
                     java.lang.String name)
              throws org.wsml.reasoner.api.inconsistency.InconsistencyException,
                     org.wsmo.common.exception.InvalidModelException

Constructor for a new (empty) ontology.

Parameters:

uri - The URI of the new ontology.

name - The name of the ontology

Throws:

org.wsml.reasoner.api.inconsistency.InconsistencyException

org.processmining.plugins.ltlchecker.models.ontology.InvalidModelException

org.wsmo.common.exception.InvalidModelException

Method Detail

serialize

public java.lang.String serialize()

isChanged

public boolean isChanged()

Returns true if the ontology model was changed (ie. concepts or attributes have been added/removed etc).

getConcepts

public java.util.Collection<ConceptModel> getConcepts()

Returns a list of all concepts which are directly referenced in the log. Directly referenced means that there is at least one element in this log which is annotated with such a concept.

Returns:

All directly referenced concepts.

getAllConcepts

public java.util.Collection<ConceptModel> getAllConcepts()

Returns a list of all concepts which are directly referenced in the log, or which are superconcepts of any concept which is directly referenced in the log. Note that this is not necessarily the list of all concepts in the ontology.

Returns:

All directly referenced concepts in the log plus all their superconcepts.

getName

public java.lang.String getName()

Returns the full URI of the ontology.

Returns:

the full ontology URI.

getUriInLog

public java.lang.String getUriInLog()

Returns the URI of the file in which the ontology is stored (can be a file or an http URL for example). Note that this can be different from the name of the ontology returned by getName().

Returns:

the full ontology URI.

getShortName

public java.lang.String getShortName()

Returns the name of the ontology without the full URI path.

Returns:

The name of the ontology without the full URI path.

getSuperConcepts

public java.util.Collection<ConceptModel> getSuperConcepts(ConceptModel concept)

Returns a collection of all superconcepts of a given concept. The reasoner is used to determine the superconcepts. This includes all superconcepts (not only the direct superconcepts), though it only returns strict superconcepts (so the returned set will not include the given concept). The reasoner is used to determine the subconcepts.

getSubConcepts

public java.util.Collection<ConceptModel> getSubConcepts(ConceptModel concept)

Returns a collection of all subconcepts of a given concept. This includes all subconcepts (not only the direct subconcepts), though it only returns strict sub concepts (so the returned set will not include the given concept). The reasoner is used to determine the subconcepts.

getDirectSubConcepts

public java.util.Collection<ConceptModel> getDirectSubConcepts(ConceptModel concept)

Returns a collection of the direct subconcepts which are directly referenced in the log.

Parameters:

concept -

Returns:

getAllDirectSubConcepts

public java.util.Collection<ConceptModel> getAllDirectSubConcepts(ConceptModel concept)

Returns a collection of all direct subconcepts, including concepts which are not directly referenced in the log.

Parameters:

concept -

Returns:

getDirectSuperConcepts

public java.util.Collection<ConceptModel> getDirectSuperConcepts(ConceptModel concept)

Returns a collection of the direct superconcepts which are directly referenced in the log.

Parameters:

concept -

Returns:

getAllDirectSuperConcepts

public java.util.Collection<ConceptModel> getAllDirectSuperConcepts(ConceptModel concept)

Returns a collection of all direct superconcepts, including concepts which are not directly referenced in the log.

Parameters:

concept -

Returns:

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getOntologyPart

public static java.lang.String getOntologyPart(java.lang.String uri)

Returns the part of the URI before the "#" character.

Parameters:

uri -

Returns:

getConceptPart

public static java.lang.String getConceptPart(java.lang.String uri)

Returns the part of the URI after the "#" character.

Parameters:

uri -

Returns:

getConceptURIInLog

public java.lang.String getConceptURIInLog(ConceptModel c)

Returns the model reference of the given concept as it is used in the log.

Parameters:

c -

Returns:

findConcept

public ConceptModel findConcept(java.lang.String conceptShortName)

Returns the concept with the given short name, or null if no such concept exists in this ontology.

Parameters:

conceptShortName -

Returns:

addConcept

public ConceptModel addConcept(java.lang.String conceptShortName)
                        throws org.wsmo.common.exception.InvalidModelException

Adds a new concept with the given name to this ontology. Note that this concept is not referenced in any log, so it does not show up in any visualization yet!

Parameters:

conceptShortName - The short name of the concept to create

Returns:

The created concept

Throws:

org.processmining.plugins.ltlchecker.models.ontology.InvalidModelException

org.wsmo.common.exception.InvalidModelException