net.sourceforge.fluxion.runcible
Interface Mapping

All Known Implementing Classes:

MappingImpl

public interface Mapping

The interface that defines what a runcible mapping looks like. Simple, a Mapping contains the URI of the source and target ontologies (those being mapped from/to) and a set of rules to apply.

A listener can be registered onto the mapping to be notified of changes to the mapping ad they occur.

Version:

1.0

Author:

Tony Burdett

Method Summary

void	addRule(Rule rule) Add a Rule to this Mapping
void	deregisterMappingListener(MappingListener listener) Removes a MappingListener from this Mapping.
Rule	findBoundVariable(java.lang.String boundVariableID) Locate a rule within this Mapping with the bound data variable, using the given bound variable ID.
Rule	findRule(java.lang.String variableID) Locate a rule within this Mapping with the a "forall" statement with the given variable ID.
java.util.Set<Rule>	getRules() Returns the Set of Rules that make up this mapping.
java.net.URI	getSourceOntologyURI() Get the URI of the source ontology.
java.net.URI	getTargetOntologyURI() Get the URI of the target ontology.
void	registerMappingListener(MappingListener listener) Adds a MappingListener to this Mapping.
void	removeRule(Rule rule) Remove a rule from this mapping
void	setSourceOntologyURI(java.net.URI sourceURI) Set the URI of the source ontology for this mapping.
void	setTargetOntologyURI(java.net.URI targetURI) Set the URI of the target ontology for this mapping.

Method Detail

setSourceOntologyURI

void setSourceOntologyURI(java.net.URI sourceURI)

Set the URI of the source ontology for this mapping.

Parameters:

sourceURI - the URI of the source ontology

getSourceOntologyURI

java.net.URI getSourceOntologyURI()

Get the URI of the source ontology.

Returns:

the source ontology uri

setTargetOntologyURI

void setTargetOntologyURI(java.net.URI targetURI)

Set the URI of the target ontology for this mapping.

Parameters:

targetURI - the URI of the target ontology

getTargetOntologyURI

java.net.URI getTargetOntologyURI()

Get the URI of the target ontology.

Returns:

the target ontology uri

addRule

void addRule(Rule rule)

Add a Rule to this Mapping

Parameters:

rule - the Rule to add

getRules

java.util.Set<Rule> getRules()

Returns the Set of Rules that make up this mapping.

Returns:

the set of Rules making up this mapping

removeRule

void removeRule(Rule rule)

Remove a rule from this mapping

Parameters:

rule - the Rule to remove

registerMappingListener

void registerMappingListener(MappingListener listener)

Adds a MappingListener to this Mapping.

Parameters:

listener - a MappingListener to register to this Mapping

deregisterMappingListener

void deregisterMappingListener(MappingListener listener)

Removes a MappingListener from this Mapping.

Parameters:

listener - the MappingListener to deregister from this Mapping

findRule

Rule findRule(java.lang.String variableID)

Locate a rule within this Mapping with the a "forall" statement with the given variable ID. This will walk all rules in this mapping until it locates a rule with a forall statement which declares this variable ID, and if found will return the rule. If there is no rule with this ID, null is returned.

Parameters:

variableID - the variable ID of the forall statement in the Rule we wish to locate

Returns:

the Rule containing this forall ID

findBoundVariable

Rule findBoundVariable(java.lang.String boundVariableID)

Locate a rule within this Mapping with the bound data variable, using the given bound variable ID. This will walk all rules in this mapping until it locates a rule with a DataClause about the given bound variable ID, and if found will return it. If there is no rule with this ID, null is returned.

Parameters:

boundVariableID - the variable ID of a dataclause within the Rule being located

Returns:

the Rule which contains a dataclause with this variable ID.