org.protempa.dest.table

Class PropositionColumnSpec

java.lang.Object

org.protempa.dest.table.AbstractTableColumnSpec

org.protempa.dest.table.PropositionColumnSpec

All Implemented Interfaces:

TableColumnSpec

public class PropositionColumnSpec
extends AbstractTableColumnSpec

Constructor Summary

Constructors

Constructor and Description
PropositionColumnSpec(String[] propertyNames)
PropositionColumnSpec(String[] propertyNames, OutputConfig outputConfig, ValueOutputConfig valueOutputConfig)
PropositionColumnSpec(String[] propertyNames, OutputConfig outputConfig, ValueOutputConfig valueOutputConfig, Link[] links)
PropositionColumnSpec(String[] propertyNames, OutputConfig outputConfig, ValueOutputConfig valueOutputConfig, Link[] links, int numInstances)
PropositionColumnSpec(String columnNamePrefixOverride, String[] propertyNames)
PropositionColumnSpec(String columnNamePrefixOverride, String[] propertyNames, OutputConfig outputConfig, ValueOutputConfig valueOutputConfig, Link[] links, int numInstances)

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.
protected String[]	columnNames(String prefix)
void	columnValues(String key, Proposition proposition, Map<Proposition,List<Proposition>> forwardDerivations, Map<Proposition,List<Proposition>> backwardDerivations, Map<UniqueId,Proposition> references, KnowledgeSourceCache propDefCache, Map<String,String> replace, char delimiter, Writer 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()
int	getNumInstances()
OutputConfig	getOutputConfig()
String[]	getPropertyNames()
org.protempa.dest.table.PropositionColumnSpec.ValuesPropositionVisitor	getPropositionVisitor()
ValueOutputConfig	getValueOutputConfig()
int	hashCode()
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

PropositionColumnSpec

public PropositionColumnSpec(String[] propertyNames)

PropositionColumnSpec

public PropositionColumnSpec(String columnNamePrefixOverride,
                             String[] propertyNames)

PropositionColumnSpec

public PropositionColumnSpec(String[] propertyNames,
                             OutputConfig outputConfig,
                             ValueOutputConfig valueOutputConfig)

PropositionColumnSpec

public PropositionColumnSpec(String[] propertyNames,
                             OutputConfig outputConfig,
                             ValueOutputConfig valueOutputConfig,
                             Link[] links)

PropositionColumnSpec

public PropositionColumnSpec(String[] propertyNames,
                             OutputConfig outputConfig,
                             ValueOutputConfig valueOutputConfig,
                             Link[] links,
                             int numInstances)

PropositionColumnSpec

public PropositionColumnSpec(String columnNamePrefixOverride,
                             String[] propertyNames,
                             OutputConfig outputConfig,
                             ValueOutputConfig valueOutputConfig,
                             Link[] links,
                             int numInstances)

Method Detail

columnNames

protected String[] columnNames(String prefix)

columnValues

public void columnValues(String key,
                         Proposition proposition,
                         Map<Proposition,List<Proposition>> forwardDerivations,
                         Map<Proposition,List<Proposition>> backwardDerivations,
                         Map<UniqueId,Proposition> references,
                         KnowledgeSourceCache propDefCache,
                         Map<String,String> replace,
                         char delimiter,
                         Writer writer)
                  throws IOException

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:

IOException

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

getLinks

public Link[] getLinks()

getPropertyNames

public String[] getPropertyNames()

getNumInstances

public int getNumInstances()

getColumnNamePrefixOverride

public String getColumnNamePrefixOverride()

getOutputConfig

public OutputConfig getOutputConfig()

getValueOutputConfig

public ValueOutputConfig getValueOutputConfig()

getPropositionVisitor

public org.protempa.dest.table.PropositionColumnSpec.ValuesPropositionVisitor getPropositionVisitor()

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