org.protempa.dest.table

Class Link

java.lang.Object

org.protempa.dest.table.Link

Direct Known Subclasses:

Derivation, Reference

public abstract class Link
extends Object

Representation of links between propositions in the PROTEMPA virtual data model. Links may be derivations or references. This class represents a link as being from one proposition to a collection of propositions. The collection of propositions may be filtered by proposition id, the values of its properties, and then by index (according to some specified ordering of the propositions).

Author:

Andrew Post

Method Summary

Modifier and Type	Method and Description
protected List<Proposition>	createResults(List<Proposition> propositions) Filters out propositions by applying the property constraint and index constraints.
boolean	equals(Object obj)
Comparator<Proposition>	getComparator() A comparator for ordering the propositions at the end of the traversal.
PropertyConstraint[]	getConstraints() Constraints on properties of the propositions at the end of the traversal.
int	getFromIndex() The start index of the propositions of interest at the end of the traversal step, after applying the proposition id constraints, property constraints and a comparator.
abstract String[]	getInferredPropositionIds(KnowledgeSource knowledgeSource, String[] inPropIds) Aggregates and returns the possible proposition ids on the right-hand side of the link.
String[]	getPropositionIds() The ids of the propositions to traverse to.
int	getToIndex() The last index of the propositions of interest at the end of the traversal step exclusive, after applying the proposition id constraints, property constraints and a comparator.
int	hashCode()
protected boolean	isMatch(Proposition proposition) Returns whether a proposition has one of the proposition ids specified by the link.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getPropositionIds

public final String[] getPropositionIds()

The ids of the propositions to traverse to. An empty array indicates that all propositions are of interest.

Returns:

a proposition id String[] Guaranteed not null.

getInferredPropositionIds

public abstract String[] getInferredPropositionIds(KnowledgeSource knowledgeSource,
                                                   String[] inPropIds)
                                            throws KnowledgeSourceReadException

Aggregates and returns the possible proposition ids on the right-hand side of the link.

Parameters:

inPropIds - the proposition ids inferred from the previous link, or the row proposition id if this is the first link.

Returns:

an array of proposition id Strings.

Throws:

KnowledgeSourceReadException

isMatch

protected boolean isMatch(Proposition proposition)

Returns whether a proposition has one of the proposition ids specified by the link.

Parameters:

proposition - a Proposition. Cannot be null.

Returns:

true or false.

getConstraints

public final PropertyConstraint[] getConstraints()

Constraints on properties of the propositions at the end of the traversal.

Returns:

a PropertyConstraint[]. Guaranteed not null.

getComparator

public final Comparator<Proposition> getComparator()

A comparator for ordering the propositions at the end of the traversal. If null, the propositions will not be provided in any particular order.

Returns:

a Comparator.

getFromIndex

public final int getFromIndex()

The start index of the propositions of interest at the end of the traversal step, after applying the proposition id constraints, property constraints and a comparator.

Returns:

an int, with zero or a negative number indicating the beginning of the list.

getToIndex

public final int getToIndex()

The last index of the propositions of interest at the end of the traversal step exclusive, after applying the proposition id constraints, property constraints and a comparator.

Returns:

an int, with a negative number indicating the end of the list. Must be greater than the fromIndex.

createResults

protected final List<Proposition> createResults(List<Proposition> propositions)

Filters out propositions by applying the property constraint and index constraints. Modifies propositions in-place!

Parameters:

propositions - a Collection. If null, an empty list is returned.

Returns:

a List. Not guaranteed to be modifiable.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object