org.protempa.dest.table

Class Reference

java.lang.Object

org.protempa.dest.table.Link

org.protempa.dest.table.Reference

public final class Reference
extends Link

Specifies reference traversals from one proposition to other propositions.

Author:

Andrew Post

Constructor Summary

Constructors

Constructor and Description
Reference(String referenceName) Creates an instance that specifies traversals using the specified reference from a proposition to all referred-to propositions.
Reference(String[] referenceNames) Creates an instance that specifies traversals using the specified references from a proposition to all referred-to propositions.
Reference(String[] referenceNames, String[] propositionIds) Creates an instance that specifies traversals using the specified references from a proposition only to propositions with the given ids.
Reference(String[] referenceNames, String[] propositionIds, PropertyConstraint[] constraints) Creates an instance that specifies traversals using the specified references from a proposition only to propositions with the given ids and that satisfy the specified constraints.
Reference(String[] referenceNames, String[] propositionIds, PropertyConstraint[] constraints, Comparator<Proposition> comparator, int index) Creates an instance that specifies traversals using the specified references from a proposition only to propositions with the given ids and that satisfy the specified constraints.
Reference(String[] referenceNames, String[] propositionIds, PropertyConstraint[] constraints, Comparator<Proposition> comparator, int fromIndex, int toIndex) Creates an instance that specifies traversals using the specified references from a proposition only to propositions with the given ids and that satisfy the specified constraints.
Reference(String referenceName, String[] propositionIds) Creates an instance that specifies traversals using the specified reference from a proposition only to propositions with the given ids.
Reference(String referenceName, String[] propositionIds, PropertyConstraint[] constraints) Creates an instance that specifies traversals using the specified references from a proposition only to propositions with the given ids and that satisfy the specified property constraints.
Reference(String referenceName, String[] propositionIds, PropertyConstraint[] constraints, Comparator<Proposition> comparator, int index) Creates an instance that specifies traversals using the specified reference from a proposition only to propositions with the given ids and that satisfy the specified property constraints.
Reference(String referenceName, String[] propositionIds, PropertyConstraint[] constraints, Comparator<Proposition> comparator, int fromIndex, int toIndex) Creates an instance that specifies traversals using the specified reference from a proposition only to propositions with the given ids and that satisfy the specified constraints.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String[]	getInferredPropositionIds(KnowledgeSource knowledgeSource, String[] inPropIds) Aggregates and returns the possible proposition ids on the right-hand side of the link.
String[]	getReferenceNames() Gets the names of the reference(s) to be traversed.
int	hashCode()
String	toString()

Methods inherited from class org.protempa.dest.table.Link

createResults, getComparator, getConstraints, getFromIndex, getPropositionIds, getToIndex, isMatch

Methods inherited from class java.lang.Object

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

Constructor Detail

Reference

public Reference(String[] referenceNames)

Creates an instance that specifies traversals using the specified references from a proposition to all referred-to propositions.

Parameters:

referenceNames - a String[] of reference names. An empty * or null array specifies that all references should be traversed.

Reference

public Reference(String[] referenceNames,
                 String[] propositionIds)

Creates an instance that specifies traversals using the specified references from a proposition only to propositions with the given ids.

Parameters:

referenceNames - a String[] of reference names. An empty * or null array specifies that all references should be traversed.

propositionIds - a String[] of proposition ids. An empty * or null array specifies that all propositions on the right-hand-side of the reference should be used.

Reference

public Reference(String[] referenceNames,
                 String[] propositionIds,
                 PropertyConstraint[] constraints)

Creates an instance that specifies traversals using the specified references from a proposition only to propositions with the given ids and that satisfy the specified constraints.

Parameters:

referenceNames - a String[] of reference names. An empty * or null array specifies that all references should be traversed.

propositionIds - a String[] of proposition ids. An empty * or null array specifies that all propositions on the right-hand-side of a reference should be used.

constraints - a PropertyConstraint[] of property constraints on the propositions on the right-hand-side of a reference. An empty or null array specifies that no constraints should be applied.

Reference

public Reference(String[] referenceNames,
                 String[] propositionIds,
                 PropertyConstraint[] constraints,
                 Comparator<Proposition> comparator,
                 int index)

Creates an instance that specifies traversals using the specified references from a proposition only to propositions with the given ids and that satisfy the specified constraints. It also allows specifying the first, second, or other proposition on the right-hand-side of the reference.

Parameters:

referenceNames - a String[] of reference names. An empty * or null array specifies that all references should be traversed.

propositionIds - a String[] of proposition ids. An empty * or null array specifies that all propositions on the right-hand-side of a reference should be used.

constraints - a PropertyConstraint[] of property constraints on the propositions on the right-hand-side of a reference. An empty * or null array specifies that no constraints should be applied.

comparator - a comparison function representing the total order to apply to propositions on the right-hand-side of the reference when using the index parameter. If null and an index is specified, the total order is unspecified.

index - the position of the proposition on the right-hand-side of the reference to traverse to, using the total order specified by the comparator argument. An index of -1 means that all propositions on the right-hand-side will be traversed to.

Reference

public Reference(String[] referenceNames,
                 String[] propositionIds,
                 PropertyConstraint[] constraints,
                 Comparator<Proposition> comparator,
                 int fromIndex,
                 int toIndex)

Creates an instance that specifies traversals using the specified references from a proposition only to propositions with the given ids and that satisfy the specified constraints. It also allows specifying a range of propositions on the right-hand-side of the reference to be traversed to (first and second, first through third, etc.).

Parameters:

referenceNames - a String[] of reference names. An empty * or null array specifies that all references should be traversed.

propositionIds - a String[] of proposition ids. An empty * or null array specifies that all propositions on the right-hand-side of a reference should be used.

constraints - a PropertyConstraint[] of property constraints on the propositions on the right-hand-side of a reference. An empty * or null array specifies that no constraints should be applied.

comparator - a comparison function representing the total order to apply to propositions on the right-hand-side of the reference when using the index parameter. If null and an index is specified, the total order is unspecified.

fromIndex - the lower-bound on the positions of the propositions on the right-hand-side of the reference to traverse to, inclusive, using the total order specified by the comparator argument. An index of -1 means that all propositions on the right-hand-side will be traversed to.

toIndex - the upper-bound on the positions of the propositions on the right-hand-side of the reference to traverse to, exclusive, using the total order specified by the comparator argument. An index of -1 means that all propositions on the right-hand-side will be traversed to.

Reference

public Reference(String referenceName)

Creates an instance that specifies traversals using the specified reference from a proposition to all referred-to propositions.

Parameters:

referenceName - a reference name String A value of null specifies that all references should be traversed.

Reference

public Reference(String referenceName,
                 String[] propositionIds)

Creates an instance that specifies traversals using the specified reference from a proposition only to propositions with the given ids.

Parameters:

referenceName - a reference name String A value of null specifies that all references should be traversed.

propositionIds - a String[] of proposition ids. An empty * or null array specifies that all propositions on the right-hand-side of the reference should be used.

Reference

public Reference(String referenceName,
                 String[] propositionIds,
                 PropertyConstraint[] constraints)

Creates an instance that specifies traversals using the specified references from a proposition only to propositions with the given ids and that satisfy the specified property constraints.

Parameters:

referenceName - a reference name String A value of null specifies that all references should be traversed.

propositionIds - a String[] of proposition ids. An empty * or null array specifies that all propositions on the right-hand-side of a reference should be used.

constraints - a PropertyConstraint[] of property constraints on the propositions on the right-hand-side of a reference. An empty or null array specifies that no constraints should be applied.

Reference

public Reference(String referenceName,
                 String[] propositionIds,
                 PropertyConstraint[] constraints,
                 Comparator<Proposition> comparator,
                 int index)

Creates an instance that specifies traversals using the specified reference from a proposition only to propositions with the given ids and that satisfy the specified property constraints. It also allows specifying the first, second, or other proposition on the right-hand-side of the reference.

Parameters:

referenceName - a reference name String A value of null specifies that all references should be traversed.

propositionIds - a String[] of proposition ids. An empty * or null array specifies that all propositions on the right-hand-side of a reference should be used.

constraints - a PropertyConstraint[] of property constraints on the propositions on the right-hand-side of a reference. An empty * or null array specifies that no constraints should be applied.

comparator - a comparison function representing the total order to apply to propositions on the right-hand-side of the reference when using the index parameter. If null and an index is specified, the total order is unspecified.

index - the position of the proposition on the right-hand-side of the reference to traverse to, using the total order specified by the comparator argument. An index of -1 means that all propositions on the right-hand-side will be traversed to.

Reference

public Reference(String referenceName,
                 String[] propositionIds,
                 PropertyConstraint[] constraints,
                 Comparator<Proposition> comparator,
                 int fromIndex,
                 int toIndex)

Creates an instance that specifies traversals using the specified reference from a proposition only to propositions with the given ids and that satisfy the specified constraints. It also allows specifying a range of propositions on the right-hand-side of the reference to be traversed to (first and second, first through third, etc.).

Parameters:

referenceName - a reference name String A value of null specifies that all references should be traversed.

propositionIds - a String[] of proposition ids. An empty * or null array specifies that all propositions on the right-hand-side of a reference should be used.

constraints - a PropertyConstraint[] of property constraints on the propositions on the right-hand-side of a reference. An empty * or null array specifies that no constraints should be applied.

comparator - a comparison function representing the total order to apply to propositions on the right-hand-side of the reference when using the index parameter. If null and an index is specified, the total order is unspecified.

fromIndex - the lower-bound on the positions of the propositions on the right-hand-side of the reference to traverse to, inclusive, using the ordering specified by the comparator argument. An index * of -1 means that all propositions on the right-hand-side will be traversed to.

toIndex - the upper-bound on the positions of the propositions on the right-hand-side of the reference to traverse to, exclusive, using the ordering specified by the comparator argument. An index * of -1 means that all propositions on the right-hand-side will be traversed to.

Method Detail

getReferenceNames

public String[] getReferenceNames()

Gets the names of the reference(s) to be traversed.

Returns:

a String[] of reference names.

getInferredPropositionIds

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

Description copied from class: Link

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

Specified by:

getInferredPropositionIds in class Link

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

toString

public String toString()

Overrides:

toString in class Link

hashCode

public int hashCode()

Overrides:

hashCode in class Link

equals

public boolean equals(Object obj)

Overrides:

equals in class Link