org.protempa.dest.table

Class PropositionValueColumnSpec

java.lang.Object

org.protempa.dest.table.AbstractTableColumnSpec

org.protempa.dest.table.PropositionValueColumnSpec

All Implemented Interfaces:

TableColumnSpec

public class PropositionValueColumnSpec
extends AbstractTableColumnSpec

Creates a column with an aggregation of primitive parameters with numerical values. For MAX and MIN on data with InequalityNumberValues for which a comparison between the inequality number and another number is not possible, we convert to NumberValues before comparison. For example, given two numbers < 4 and 3, we convert < 4 to 4 before aggregation because otherwise the two numbers are not comparable.

Author:

Andrew Post

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PropositionValueColumnSpec.Type

Constructor Summary

Constructors

Constructor and Description
PropositionValueColumnSpec(Link[] links, PropositionValueColumnSpec.Type aggregationType)
PropositionValueColumnSpec(String columnNamePrefixOverride, Link[] links, PropositionValueColumnSpec.Type aggregationType)

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	getColumnNamePrefixOverride()
String[]	getInferredPropositionIds(KnowledgeSource knowledgeSource, String[] inPropIds) Infers the ids of the propositions corresponding to the contents of this column.
Link[]	getLinks()
PropositionValueColumnSpec.Type	getType()
int	hashCode()
void	setType(PropositionValueColumnSpec.Type type)
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

PropositionValueColumnSpec

public PropositionValueColumnSpec(Link[] links,
                                  PropositionValueColumnSpec.Type aggregationType)

PropositionValueColumnSpec

public PropositionValueColumnSpec(String columnNamePrefixOverride,
                                  Link[] links,
                                  PropositionValueColumnSpec.Type aggregationType)

Method Detail

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

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.

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

getType

public PropositionValueColumnSpec.Type getType()

setType

public void setType(PropositionValueColumnSpec.Type type)

getLinks

public Link[] getLinks()

getColumnNamePrefixOverride

public String getColumnNamePrefixOverride()

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object