org.protempa.dest.table

Class CountColumnSpec

java.lang.Object

org.protempa.dest.table.AbstractTableColumnSpec

org.protempa.dest.table.CountColumnSpec

All Implemented Interfaces:

TableColumnSpec

public final class CountColumnSpec
extends AbstractTableColumnSpec

Counts the number of instances of a proposition.

Author:

arpost

Constructor Summary

Constructors

Constructor and Description
CountColumnSpec(Link[] links)
CountColumnSpec(String columnNameOverride, Link[] links, boolean countUnique) Constructs a count column spec with an optional header name, the links to traverse and whether to count the number of unique proposition ids rather than the number of propositions.

Method Summary

Modifier and Type	Method and Description
String[]	columnNames(KnowledgeSource knowledgeSource) Gets the names of the columns representing one instance of a proposition or property.
void	columnValues(String key, Proposition proposition, Map<Proposition,List<Proposition>> forwardDerivations, Map<Proposition,List<Proposition>> backwardDerivations, Map<UniqueId,Proposition> references, KnowledgeSourceCache ksCache, TabularWriter writer) Gets the values of the specified propositions or properties for one row of data.
boolean	equals(Object obj)
String	getColumnNameOverride()
String[]	getInferredPropositionIds(KnowledgeSource knowledgeSource, String[] inPropIds) Infers the ids of the propositions corresponding to the contents of this column.
Link[]	getLinks()
int	hashCode()
boolean	isCountUnique()
void	validate(KnowledgeSource knowledgeSource) Validates the fields of this column specification against the knowledge source.

Methods inherited from class java.lang.Object

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

Constructor Detail

CountColumnSpec

public CountColumnSpec(Link[] links)

CountColumnSpec

public CountColumnSpec(String columnNameOverride,
                       Link[] links,
                       boolean countUnique)

Constructs a count column spec with an optional header name, the links to traverse and whether to count the number of unique proposition ids rather than the number of propositions.

Parameters:

columnNameOverride - an optional header name. Will use a default that is computed from the specified links (below).

links - the links to traverse.

countUnique - if true, count the unique ids of the propositions at the end of the link traversal.

Method Detail

columnNames

public String[] columnNames(KnowledgeSource knowledgeSource)
                     throws KnowledgeSourceReadException

Description copied from interface: TableColumnSpec

Gets the names of the columns representing one instance of a proposition or property. These columns may be repeated if the specification results in matching more than one proposition or property.

Parameters:

knowledgeSource - the active KnowledgeSource.

Returns:

a String[] of column names.

Throws:

KnowledgeSourceReadException - if an attempt at reading from the knowledge source failed.

columnValues

public void columnValues(String key,
                         Proposition proposition,
                         Map<Proposition,List<Proposition>> forwardDerivations,
                         Map<Proposition,List<Proposition>> backwardDerivations,
                         Map<UniqueId,Proposition> references,
                         KnowledgeSourceCache ksCache,
                         TabularWriter writer)
                  throws TabularWriterException

Description copied from interface: TableColumnSpec

Gets the values of the specified propositions or properties for one row of data.

Parameters:

key - a key id String.

proposition - a List for the specified key with the specified proposition id.

Throws:

TabularWriterException

validate

public void validate(KnowledgeSource knowledgeSource)
              throws TableColumnSpecValidationFailedException,
                     KnowledgeSourceReadException

Description copied from interface: TableColumnSpec

Validates the fields of this column specification against the knowledge source.

Parameters:

knowledgeSource - a KnowledgeSource. Guaranteed not null.

Throws:

KnowledgeSourceReadException - if the knowledge source could not be read.

TableColumnSpecValidationFailedException

getColumnNameOverride

public String getColumnNameOverride()

getLinks

public Link[] getLinks()

isCountUnique

public boolean isCountUnique()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getInferredPropositionIds

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

Description copied from interface: TableColumnSpec

Infers the ids of the propositions corresponding to the contents of this column.

Returns:

an array of proposition id Strings. Guaranteed not null.

Throws:

KnowledgeSourceReadException