org.protempa.dest.table

Class ConstantColumnSpec

java.lang.Object

org.protempa.dest.table.AbstractTableColumnSpec

org.protempa.dest.table.ConstantColumnSpec

All Implemented Interfaces:

TableColumnSpec

public class ConstantColumnSpec
extends AbstractTableColumnSpec

Author:

Andrew Post

Constructor Summary

Constructors

Constructor and Description
ConstantColumnSpec(String heading, String value)

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,Set<Proposition>> forwardDerivations, Map<Proposition,Set<Proposition>> backwardDerivations, Map<UniqueId,Proposition> references, KnowledgeSourceCache knowledgeSourceCache, TabularWriter writer) Gets the values of the specified propositions or properties for one row of data.
String[]	getInferredPropositionIds(KnowledgeSource knowledgeSource, String[] inPropIds) Infers the ids of the propositions corresponding to the contents of this column.
void	validate(KnowledgeSource knowledgeSource) Validates the fields of this column specification against the knowledge source.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConstantColumnSpec

public ConstantColumnSpec(String heading,
                          String value)

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,Set<Proposition>> forwardDerivations,
                         Map<Proposition,Set<Proposition>> backwardDerivations,
                         Map<UniqueId,Proposition> references,
                         KnowledgeSourceCache knowledgeSourceCache,
                         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

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