org.protempa

Class HighLevelAbstractionDefinition

java.lang.Object

org.protempa.AbstractPropositionDefinition

org.protempa.AbstractAbstractionDefinition

org.protempa.HighLevelAbstractionDefinition

All Implemented Interfaces:

Serializable, AbstractionDefinition, PropositionDefinition, PropositionDefinitionCheckedVisitable, PropositionDefinitionVisitable, TemporalPropositionDefinition

public final class HighLevelAbstractionDefinition
extends AbstractAbstractionDefinition

Definition of an extended parameter that's a high-level abstraction.

Author:

Andrew Post

See Also:

Serialized Form

Field Summary

Fields inherited from class org.protempa.AbstractPropositionDefinition

changes, children, CHILDREN_PROPERTY

Constructor Summary

Constructors

Constructor and Description
HighLevelAbstractionDefinition(String id)

Method Summary

Modifier and Type	Method and Description
void	accept(PropositionDefinitionVisitor processor) Performs some processing on a proposition definition.
void	acceptChecked(PropositionDefinitionCheckedVisitor processor) Performs some processing on this proposition definition.
boolean	add(ExtendedPropositionDefinition def) Adds an extended proposition definition.
Set<String>	getAbstractedFrom() Returns all proposition ids from which this abstract parameter is abstracted.
Set<ExtendedPropositionDefinition>	getExtendedPropositionDefinitions() Gets the extended proposition definitions that are part of this abstraction definition.
Relation	getRelation(List<TemporalExtendedPropositionDefinition> epdPair)
Relation	getRelation(TemporalExtendedPropositionDefinition lhsDef, TemporalExtendedPropositionDefinition rhsDef) Gets the relation between two temporal extended proposition definitions.
Set<List<TemporalExtendedPropositionDefinition>>	getTemporalExtendedPropositionDefinitionPairs() Gets the temporal extended proposition definitions involved in relations as pairs.
TemporalPatternOffset	getTemporalOffset()
boolean	isConcatenable() Returns whether this type of high-level abstraction is concatenable.
boolean	isSolid() Returns whether intervals of this type are solid, i.e., never hold over properly overlapping intervals.
protected void	recalculateChildren()
boolean	remove(ExtendedPropositionDefinition def) Removes an extended proposition definition, and all relations involving it.
boolean	removeAllRelations(TemporalExtendedPropositionDefinition def) Removes all relations involving a temporal extended proposition definition.
boolean	removeRelation(TemporalExtendedPropositionDefinition lhsRule, TemporalExtendedPropositionDefinition rhsRule) Removes a relation between two temporal extended proposition definitions.
void	reset() Resets this proposition definition to default values.
void	setConcatenable(boolean concatenable) Sets whether this type of high-level abstraction is concatenable.
boolean	setRelation(TemporalExtendedPropositionDefinition lhsDef, TemporalExtendedPropositionDefinition rhsDef, Relation relation) Sets the relation between the two temporal extended proposition definitions.
void	setSolid(boolean solid) Sets whether intervals of this type are solid, i.e., never hold over properly overlapping intervals.
void	setTemporalOffset(TemporalPatternOffset temporalOffset)
String	toString()

Methods inherited from class org.protempa.AbstractAbstractionDefinition

getGapFunction, 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.AbstractionDefinition

getDescription

Methods inherited from interface org.protempa.PropositionDefinition

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

Constructor Detail

HighLevelAbstractionDefinition

public HighLevelAbstractionDefinition(String id)

Method Detail

accept

public void accept(PropositionDefinitionVisitor processor)

Description copied from interface: PropositionDefinitionVisitable

Performs some processing on a proposition definition.

acceptChecked

public void acceptChecked(PropositionDefinitionCheckedVisitor processor)
                   throws ProtempaException

Description copied from interface: PropositionDefinitionCheckedVisitable

Performs some processing on this proposition definition.

Throws:

ProtempaException

setRelation

public boolean setRelation(TemporalExtendedPropositionDefinition lhsDef,
                           TemporalExtendedPropositionDefinition rhsDef,
                           Relation relation)

Sets the relation between the two temporal extended proposition definitions.

Parameters:

lhsDef - a TemporalExtendedPropositionDefinition.

rhsDef - a TemporalExtendedPropositionDefinition.

relation - a Relation.

Returns:

true if setting the relation was successful, false otherwise (e.g., if one or both of the temporal extended proposition definitions is not already part of this abstraction definition, or if any of the arguments are null).

removeRelation

public boolean removeRelation(TemporalExtendedPropositionDefinition lhsRule,
                              TemporalExtendedPropositionDefinition rhsRule)

Removes a relation between two temporal extended proposition definitions.

Parameters:

lhsRule - a TemporalExtendedPropositionDefinition.

rhsRule - a TemporalExtendedPropositionDefinition.

Returns:

true if removing the relation was successful, false otherwise (e.g., if either argument is null, the arguments are not part of this abstraction definition, or if no relation was set for them).

getExtendedPropositionDefinitions

public Set<ExtendedPropositionDefinition> getExtendedPropositionDefinitions()

Gets the extended proposition definitions that are part of this abstraction definition.

Returns:

a Set of ExtendedPropositionDefinitions.

getAbstractedFrom

public Set<String> getAbstractedFrom()

Description copied from interface: AbstractionDefinition

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

Returns:

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

add

public boolean add(ExtendedPropositionDefinition def)

Adds an extended proposition definition.

Parameters:

def - an ExtendedPropositionDefinition.

Returns:

true if successfully added, false otherwise (e.g., the ExtendedPropositionDefinition is null or is already part of this abstraction definition.

getRelation

public Relation getRelation(TemporalExtendedPropositionDefinition lhsDef,
                            TemporalExtendedPropositionDefinition rhsDef)

Gets the relation between two temporal extended proposition definitions.

Parameters:

lhsDef - a TemporalExtendedPropositionDefinition.

rhsDef - a TemporalExtendedPropositionDefinition.

Returns:

a Relation, or null if none was found.

getRelation

public Relation getRelation(List<TemporalExtendedPropositionDefinition> epdPair)

removeAllRelations

public boolean removeAllRelations(TemporalExtendedPropositionDefinition def)

Removes all relations involving a temporal extended proposition definition.

Parameters:

def - a TemporalExtendedPropositionDefinition.

Returns:

true if all such relations were removed, false otherwise.

remove

public boolean remove(ExtendedPropositionDefinition def)

Removes an extended proposition definition, and all relations involving it.

Parameters:

def - an ExtendedPropositionDefinition.

Returns:

true if successful, false otherwise.

getTemporalExtendedPropositionDefinitionPairs

public Set<List<TemporalExtendedPropositionDefinition>> getTemporalExtendedPropositionDefinitionPairs()

Gets the temporal extended proposition definitions involved in relations as pairs.

Returns:

an unmodifiable Set of Lists of two TemporalExtendedPropositionDefinitions, with the first element the left-hand side of a relation, and the second element the right-hand side of a relation.

getTemporalOffset

public TemporalPatternOffset getTemporalOffset()

setTemporalOffset

public void setTemporalOffset(TemporalPatternOffset temporalOffset)

reset

public void reset()

Description copied from class: AbstractPropositionDefinition

Resets this proposition definition to default values.

Overrides:

reset in class AbstractAbstractionDefinition

setConcatenable

public void setConcatenable(boolean concatenable)

Sets whether this type of high-level abstraction is concatenable.

Parameters:

concatenable - true if concatenable, false if not.

setSolid

public void setSolid(boolean solid)

Sets whether intervals of this type are solid, i.e., never hold over properly overlapping intervals.

Parameters:

solid - true or false.

isConcatenable

public boolean isConcatenable()

Returns whether this type of high-level abstraction is concatenable. The default for high-level abstractions is concatenable.

Returns:

true if concatenable, false if not.

See Also:

PropositionDefinition.isConcatenable()

isSolid

public boolean isSolid()

Returns whether intervals of this type are solid, i.e., never hold over properly overlapping intervals. By default, high-level abstraction intervals are solid.

Returns:

true or false.

recalculateChildren

protected void recalculateChildren()

Specified by:

recalculateChildren in class AbstractPropositionDefinition

toString

public String toString()

Overrides:

toString in class AbstractAbstractionDefinition