prajna.ontology

Class SemanticAugmenter

java.lang.Object

prajna.ontology.SemanticAugmenter

Direct Known Subclasses:

GeoAugmenter, GeoNamesAugmenter, SwrlAugmenter

public abstract class SemanticAugmenter
extends java.lang.Object

Abstract class for augmenting semantic objects with external sources of data. A SementicAugmenter enhances the data within OwlThings based upon some source of information. For instance, one augmenter could retrieve information from a database, or another could perform some reasoning process.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
SemanticAugmenter() Create a new SemanticAugmenter.
SemanticAugmenter(java.lang.String propNames) Create a new Semantic Augmenter which augments information in the specified property.
SemanticAugmenter(java.lang.String className, java.lang.String propName) Create a new Semantic Augmenter which augments information in the specified property for the specified class.

Method Summary

Methods

Modifier and Type	Method and Description
void	addProperties(java.lang.String propList) Add a property or list of properties by name.
void	addProperty(Property prop) Add a property which is augmented by this augmenter.
boolean	augment(OwlThing thing) Augment a particular OwlThing.
java.lang.String	getConfig() Get the configuration string.
protected abstract java.util.Set<java.lang.String>	getNewValues(OwlThing thing, Property prop) Get the new values for the thing.
OwlClass	getOwlClass() Get the OwlClass of objects that this augmenter enhances
java.util.Set<Property>	getProperties() Get the properties enhanced by this augmenter
protected abstract java.util.Set<java.lang.String>	getRefineValues(OwlThing thing) Get any possible values used to refine the class of the OwlThing passed in.
protected boolean	isOverwrite() Return whether the overwrite flag is set.
boolean	isRefine() Return whether the refine flag has been set
void	setConfig(java.lang.String configValue) Set the configuration string for this augmenter.
void	setOverwrite(boolean flag) Set the overwrite flag.
void	setOwlClass(OwlClass owlClass) Set the OwlClass of objects that this augmenter enhances
void	setRefine(boolean refineFlag) Set the flag that indicates whether this augmenter should try to refine the class of the objects it is augmenting.
java.lang.String	toString() Return a string representation of this augmenter

Methods inherited from class java.lang.Object

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

Constructor Detail

SemanticAugmenter

public SemanticAugmenter()

Create a new SemanticAugmenter.

SemanticAugmenter

public SemanticAugmenter(java.lang.String propNames)

Create a new Semantic Augmenter which augments information in the specified property. If set, the domain of the property is used for the class to be augmented. The properties may be any type of semantic property. If the property name is class or owlClass, the augmenter is configured to refine things instead of add properties to them. The properties should be comma separated.

Parameters:

propNames - Owl Property names

SemanticAugmenter

public SemanticAugmenter(java.lang.String className,
                 java.lang.String propName)

Create a new Semantic Augmenter which augments information in the specified property for the specified class. The property may be any type of semantic property.

Parameters:

className - name of the Owl Class to augment

propName - Owl Property name

Method Detail

addProperties

public void addProperties(java.lang.String propList)

Add a property or list of properties by name. If multiple properties are specified, they should be separated by commas.

Parameters:

propList - list of comma-separated properties

addProperty

public void addProperty(Property prop)

Add a property which is augmented by this augmenter. If the augmenting class is also null, this method uses the domain of the property as the augmenting class.

Parameters:

prop - the property for this augmenter

augment

public boolean augment(OwlThing thing)

Augment a particular OwlThing. This method will check the thing for validity against the augmenting class. It will invoke getNewValues(thing), and add the new values to the OwlThing. If the cardinality for the property is 1, and the overwrite flag is set, it will overwrite existing values. Otherwise it will add a new value to the thing.

Parameters:

thing - the OwlThing to enhance

Returns:

true if the thing changed as a result of this call, false otherwise.

getConfig

public java.lang.String getConfig()

Get the configuration string. The interpretation of the configuration string is dependent on the extractor.

Returns:

the configuration string. The default implementation returns null.

getNewValues

protected abstract java.util.Set<java.lang.String> getNewValues(OwlThing thing,
                                           Property prop)

Get the new values for the thing. This method should perform whatever implementation-specific reasoning or information retrieval, and derive the new values for the property for this augmenter. The implementation should not add the property values to the OwlThing, but simply determine what the new value should be.

Parameters:

thing - the thing to find the value for

prop - the property to get values for

Returns:

the set of new values for the OwlThing

getOwlClass

public OwlClass getOwlClass()

Get the OwlClass of objects that this augmenter enhances

Returns:

the OwlClass of objects that this augmenter enhances

getProperties

public java.util.Set<Property> getProperties()

Get the properties enhanced by this augmenter

Returns:

the properties enhanced by this augmenter

getRefineValues

protected abstract java.util.Set<java.lang.String> getRefineValues(OwlThing thing)

Get any possible values used to refine the class of the OwlThing passed in.

Parameters:

thing - the thing to find the possible refinements for

Returns:

the set of possible refinement values for the OwlThing

isOverwrite

protected boolean isOverwrite()

Return whether the overwrite flag is set.

Returns:

true if the overwrite flag is set, false otherwise

isRefine

public boolean isRefine()

Return whether the refine flag has been set

Returns:

the refine flag

setConfig

public void setConfig(java.lang.String configValue)

Set the configuration string for this augmenter. This method allows the individual augmenters to have a configuration parameter, such as an API key, URL, or source file of information. By default, this method does nothing. However, those augmenters which need configuration information should override this method

Parameters:

configValue - a configuration string. The format for this string is dependent on the individual augmenter

setOverwrite

public void setOverwrite(boolean flag)

Set the overwrite flag. If the overwrite flag is set, and the maximum cardinality for the object would not allow a new value to be added, this flag allows the augmenter to overwrite an existing value. False by default.

Parameters:

flag - the overwrite flag

setOwlClass

public void setOwlClass(OwlClass owlClass)

Set the OwlClass of objects that this augmenter enhances

Parameters:

owlClass - the OwlClass of objects that this augmenter enhances

setRefine

public void setRefine(boolean refineFlag)

Set the flag that indicates whether this augmenter should try to refine the class of the objects it is augmenting. If the refineFlag is set, the augmenter will attempt to determine a subclass for any object it is augmenting.

Parameters:

refineFlag - the refine flag

toString

public java.lang.String toString()

Return a string representation of this augmenter

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this augmenter