org.protempa

Class CompoundLowLevelAbstractionDefinition

java.lang.Object

org.protempa.AbstractPropositionDefinition

org.protempa.AbstractAbstractionDefinition

org.protempa.CompoundLowLevelAbstractionDefinition

All Implemented Interfaces:

Serializable, AbstractionDefinition, ParameterDefinition, PropositionDefinition, PropositionDefinitionCheckedVisitable, PropositionDefinitionVisitable, TemporalPropositionDefinition

public final class CompoundLowLevelAbstractionDefinition
extends AbstractAbstractionDefinition
implements ParameterDefinition

An abstraction for representing compound low-level abstractions. These are essentially low-level abstractions composed of multiple data types and whose values are computed based on combinations the values of the underlying low-level abstractions in overlapping intervals. Note that this is different than a LowLevelAbstractionDefinition abstracted from multiple primitive parameters. In that case, the low-level abstraction takes on a value based on the computation of all of the primitive parameter values by a single algorithm. In compound low-level abstractions, the values of the underlying low-level abstractions are considered individually, and a higher-level value is assigned to an interval based on rules. A compound low-level abstraction will generate a superset of the intervals in the abstracted-from low-level abstractions. Just as for low-level abstractions, value definitions must be created for compound low-level abstractions. These tell the abstraction how to process the values of the underlying low-level abstraction. There are two ways to consider the values of the low-level abstractions in a particular interval, provided by the enum CompoundLowLevelAbstractionDefinition.ValueDefinitionMatchOperator: ANY or ALL. Specifying ANY will make the compound abstraction apply the value under consideration if any of the low-level abstraction values in that interval match the rule for that value. ALL requires all of the low-level abstraction rules to match. The rules look something like: COMPOUND_LLA_VALUE1 = {LLA1.value=LLA1_VALUE1,LLA2.value=LLA2_VALUE1,...,LLAN.value=LLAN_VALUE1} COMPOUND_LLA_VALUE2 = {LLA1.value=LLA1_VALUE2,LLA2.value=LLA2_VALUE2,...,LLAN.value=LLAN_VALUE2} The ANY or ALL operator applies to all of the rules. It is not applied on a per-rule basis. Order matters when specifying the compound abstractions possible values. Values will be considered in the order they were defined. The last value will be considered as a catch-all if none of the others match. It should typically be the "normal" interpretation of the underlying low-level abstractions. See org.protempa.test.ProtempaTest in protempa-test-suite for examples of compound low-level abstractions.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CompoundLowLevelAbstractionDefinition.ValueDefinitionMatchOperator The different ways to consider the low-level abstraction value rules in a given interval

Field Summary

Fields inherited from class org.protempa.AbstractPropositionDefinition

changes, children, CHILDREN_PROPERTY

Constructor Summary

Constructors

Constructor and Description
CompoundLowLevelAbstractionDefinition(String id) Constructor for this class.

Method Summary

Modifier and Type	Method and Description
void	accept(PropositionDefinitionVisitor propositionVisitor) Performs some processing on a proposition definition.
void	acceptChecked(PropositionDefinitionCheckedVisitor propositionVisitor) Performs some processing on this proposition definition.
void	addValueClassification(ValueClassification valueClassification) Adds a value classification for the abstraction.
Set<String>	getAbstractedFrom() Returns all proposition ids from which this abstract parameter is abstracted.
String	getContextId()
GapFunction	getGapFunctionBetweenValues()
ContextDefinition	getInterpretationContext()
Set<String>	getLowLevelAbstractionIds() Gets the IDs of the low-level abstraction that this abstraction is abstracted from.
int	getMinimumNumberOfValues() Gets the minimum number of consecutive intervals that must have the same value before this abstraction is asserted.
int	getSkip()
ValueClassification[]	getValueClassifications()
CompoundLowLevelAbstractionDefinition.ValueDefinitionMatchOperator	getValueDefinitionMatchOperator() Gets the operator that is applied to each interval's low-level abstraction values to determine the value to set for this abstraction.
ValueType	getValueType()
boolean	isConcatenable() Returns whether instances of this proposition definition are concatenable.
boolean	isSolid() Returns whether intervals of this type are solid, i.e., never hold over properly overlapping intervals.
protected void	recalculateChildren()
void	setConcatenable(boolean concatenable) Sets whether this type of compound low-level abstraction is concatenable.
void	setContextId(String contextId)
void	setGapFunctionBetweenValues(GapFunction gf)
void	setInterpretationContext(ContextDefinition interpretationContext)
void	setMinimumNumberOfValues(int minimumNumberOfValues) Sets the minimum number of consecutive intervals that must have the same value before this abstraction is asserted.
void	setSkip(int skip)
void	setValueDefinitionMatchOperator(CompoundLowLevelAbstractionDefinition.ValueDefinitionMatchOperator valueDefinitionMatchOperator) Sets the operator that is applied to each interval's low-level abstraction values to determine the value to set for this abstraction.
String	toString()

Methods inherited from class org.protempa.AbstractAbstractionDefinition

getGapFunction, reset, setGapFunction

Methods inherited from class org.protempa.AbstractPropositionDefinition

addPropertyChangeListener, addPropertyChangeListener, attribute, getAbbreviatedDisplayName, getAccessed, getAttributes, getChildren, getCreated, getDescription, getDisplayName, getDownloaded, getId, getInDataSource, getInverseIsA, getPropertyDefinitions, getPropositionId, getReferenceDefinitions, getSourceId, getTermIds, getUpdated, getVersion, propertyDefinition, referenceDefinition, removePropertyChangeListener, removePropertyChangeListener, setAbbreviatedDisplayName, setAccessed, setAttributes, setCreated, setDescription, setDisplayName, setDownloaded, setInDataSource, setInverseIsA, setPropertyDefinitions, setPropositionId, setReferenceDefinitions, setSourceId, setTermIds, setUpdated, setVersion

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.protempa.PropositionDefinition

addPropertyChangeListener, addPropertyChangeListener, attribute, getAbbreviatedDisplayName, getAccessed, getAttributes, getChildren, getCreated, getDescription, getDisplayName, getDownloaded, getId, getInDataSource, getInverseIsA, getPropertyDefinitions, getPropositionId, getReferenceDefinitions, getSourceId, getTermIds, getUpdated, getVersion, propertyDefinition, referenceDefinition, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from interface org.protempa.AbstractionDefinition

getDescription

Constructor Detail

CompoundLowLevelAbstractionDefinition

public CompoundLowLevelAbstractionDefinition(String id)

Constructor for this class. Sets the proposition ID. Sets the minimum number of values to match to 1.

Parameters:

id - the proposition ID, a String

Method Detail

getLowLevelAbstractionIds

public Set<String> getLowLevelAbstractionIds()

Gets the IDs of the low-level abstraction that this abstraction is abstracted from. Identical to getAbstractedFrom().

Returns:

a Set of Strings that are the proposition IDs of the underlying low-level abstractions

getContextId

public String getContextId()

setContextId

public void setContextId(String contextId)

getSkip

public int getSkip()

setSkip

public void setSkip(int skip)

setGapFunctionBetweenValues

public void setGapFunctionBetweenValues(GapFunction gf)

getGapFunctionBetweenValues

public GapFunction getGapFunctionBetweenValues()

getMinimumNumberOfValues

public int getMinimumNumberOfValues()

Gets the minimum number of consecutive intervals that must have the same value before this abstraction is asserted.

Returns:

the minimum number of values, an int

setMinimumNumberOfValues

public void setMinimumNumberOfValues(int minimumNumberOfValues)

Sets the minimum number of consecutive intervals that must have the same value before this abstraction is asserted.

Parameters:

minimumNumberOfValues - the minimum number of values, an int greater than 0.

getValueDefinitionMatchOperator

public CompoundLowLevelAbstractionDefinition.ValueDefinitionMatchOperator getValueDefinitionMatchOperator()

Gets the operator that is applied to each interval's low-level abstraction values to determine the value to set for this abstraction.

Returns:

a CompoundLowLevelAbstractionDefinition.ValueDefinitionMatchOperator. The default value is ANY.

setValueDefinitionMatchOperator

public void setValueDefinitionMatchOperator(CompoundLowLevelAbstractionDefinition.ValueDefinitionMatchOperator valueDefinitionMatchOperator)

Sets the operator that is applied to each interval's low-level abstraction values to determine the value to set for this abstraction. If null, the setting will revert to the default (ANY).

Parameters:

valueDefinitionMatchOperator - the match operator to set, a CompoundLowLevelAbstractionDefinition.ValueDefinitionMatchOperator

addValueClassification

public void addValueClassification(ValueClassification valueClassification)

Adds a value classification for the abstraction. If a classification of the provided name doesn't exist, then it is created. The value definition name must be one of the values applicable to the low-level abstraction whose ID is also passed in.

Parameters:

id - the name of the value definition

lowLevelAbstractionId - the name of the low-level abstraction to add to the classification

lowLevelValueDefName - the name of the low-level abstraction's value

getValueClassifications

public ValueClassification[] getValueClassifications()

getAbstractedFrom

public Set<String> getAbstractedFrom()

Description copied from interface: AbstractionDefinition

Returns all proposition ids from which this abstract parameter is abstracted.

Specified by:

getAbstractedFrom in interface AbstractionDefinition

Returns:

an unmodifiable Set of proposition id Strings. Guaranteed not null.

setConcatenable

public void setConcatenable(boolean concatenable)

Sets whether this type of compound low-level abstraction is concatenable.

Parameters:

concatenable - true if concatenable, false if not.

isConcatenable

public boolean isConcatenable()

Description copied from interface: PropositionDefinition

Returns whether instances of this proposition definition are concatenable. A proposition is concatenable if, whenever it holds over two consecutive time intervals, it holds also over their union.

Specified by:

isConcatenable in interface PropositionDefinition

Returns:

true if concatenable, false if not.

isSolid

public boolean isSolid()

Description copied from interface: PropositionDefinition

Returns whether intervals of this type are solid, i.e., never hold over properly overlapping intervals. For example, a proposition representing a pregnancy is solid because it is not possible for two pregnancies to overlap in time. This field could be used for data and interval validation. It alternatively could be used to merge overlapping propositions if there are multiple ways to infer a proposition. This field is settable for some types of propositions.

Specified by:

isSolid in interface PropositionDefinition

Returns:

true if solid, false if not.

getInterpretationContext

public ContextDefinition getInterpretationContext()

setInterpretationContext

public void setInterpretationContext(ContextDefinition interpretationContext)

getValueType

public ValueType getValueType()

Specified by:

getValueType in interface ParameterDefinition

acceptChecked

public void acceptChecked(PropositionDefinitionCheckedVisitor propositionVisitor)
                   throws ProtempaException

Description copied from interface: PropositionDefinitionCheckedVisitable

Performs some processing on this proposition definition.

Specified by:

acceptChecked in interface PropositionDefinitionCheckedVisitable

Throws:

ProtempaException

accept

public void accept(PropositionDefinitionVisitor propositionVisitor)

Description copied from interface: PropositionDefinitionVisitable

Performs some processing on a proposition definition.

Specified by:

accept in interface PropositionDefinitionVisitable

recalculateChildren

protected void recalculateChildren()

Specified by:

recalculateChildren in class AbstractPropositionDefinition

toString

public String toString()

Overrides:

toString in class AbstractAbstractionDefinition