LowLevelAbstractionDefinition (Protempa Framework 4.0.1 API)

java.lang.Object
- org.protempa.AbstractPropositionDefinition
- - org.protempa.AbstractAbstractionDefinition
  - - org.protempa.LowLevelAbstractionDefinition

All Implemented Interfaces:

Serializable, AbstractionDefinition, ParameterDefinition, PropositionDefinition, PropositionDefinitionCheckedVisitable, PropositionDefinitionVisitable, TemporalPropositionDefinition
```
public final class LowLevelAbstractionDefinition
extends AbstractAbstractionDefinition
implements ParameterDefinition
```
Definition of low-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

LowLevelAbstractionDefinition(String id)

Constructors
Constructor and Description
`LowLevelAbstractionDefinition(String id)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
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`	`addPrimitiveParameterId(String paramId)` Adds a primitive parameter from which this abstraction is inferred.
`boolean`	`addValueDefinition(LowLevelAbstractionValueDefinition d)`
`Set<String>`	`getAbstractedFrom()` Returns all proposition ids from which this abstract parameter is abstracted.
`String`	`getAlgorithmId()`
`String`	`getContextId()`
`String`	`getId()`
`Integer`	`getMaximumDuration()`
`Unit`	`getMaximumDurationUnits()`
`Integer`	`getMaximumGapBetweenValues()` Returns the minimum distance between instances of this `AbstractionDefinition` that are concatenable.
`Unit`	`getMaximumGapBetweenValuesUnits()`
`int`	`getMaximumNumberOfValues()` Sets the maximum number of sequential values to process.
`int`	`getMaxOverlapping()` Return the value of the max-overlapping restart search directive.
`Integer`	`getMinimumDuration()`
`Unit`	`getMinimumDurationUnits()`
`Integer`	`getMinimumGapBetweenValues()`
`Unit`	`getMinimumGapBetweenValuesUnits()`
`int`	`getMinimumNumberOfValues()` Gets the minimum number of sequential values to process.
`int`	`getSkip()` Return the value of the skip restart search directive.
`int`	`getSkipEnd()` Return the value of the skip-end restart search directive.
`int`	`getSkipStart()` Return the value of the skip-start restart search directive.
`SlidingWindowWidthMode`	`getSlidingWindowWidthMode()` Gets the sliding window width mode.
`List<LowLevelAbstractionValueDefinition>`	`getValueDefinitions()`
`LowLevelAbstractionValueDefinition[]`	`getValueDefinitions(String id)`
`ValueType`	`getValueType()`
`boolean`	`isConcatenable()` Returns whether this type of low-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`	`removePrimitiveParameterId(String paramId)` Removes a primitive parameter from which this abstraction is inferred.
`void`	`reset()` Resets this proposition definition to default values.
`void`	`setAlgorithmId(String algorithmId)`
`void`	`setConcatenable(boolean concatenable)` Sets whether this type of low-level abstraction is concatenable.
`void`	`setContextId(String contextId)`
`void`	`setMaximumDuration(Integer maxDuration)`
`void`	`setMaximumDurationUnits(Unit maxDurationUnits)`
`void`	`setMaximumGapBetweenValues(Integer maximumGapBetweenValues)` Sets the maximum distance between instances of this `AbstractionDefinition` that are contatenable.
`void`	`setMaximumGapBetweenValuesUnits(Unit units)`
`void`	`setMaximumNumberOfValues(int l)` Sets the maximum number of sequential values to process.
`void`	`setMaxOverlapping(int arg)` Enable the max-overlapping restart search directive.
`void`	`setMinimumDuration(Integer minDuration)`
`void`	`setMinimumDurationUnits(Unit minDurationUnits)`
`void`	`setMinimumGapBetweenValues(Integer minimumGapBetweenValues)` Sets the minimum distance between instances of this `AbstractionDefinition` that are concatenable.
`void`	`setMinimumGapBetweenValuesUnits(Unit units)`
`void`	`setMinimumNumberOfValues(int l)` Sets the minimum number of sequential values to process.
`void`	`setSkip(int arg)` Enable the skip restart search directive.
`void`	`setSkipEnd(int arg)` Enable the skip-end restart search directive.
`void`	`setSkipStart(int arg)` Enable the skip-start restart search directive.
`void`	`setSlidingWindowWidthMode(SlidingWindowWidthMode slidingWindowWidthMode)` Sets the sliding window width mode.
`void`	`setValueType(ValueType c)`
`String`	`toString()`
`void`	`unsetMaxOverlapping()` Disable the max-overlapping restart search directive.
`void`	`unsetSkip()` Disable the skip restart search directive.
`void`	`unsetSkipEnd()` Disable the skip-end restart search directive.
`void`	`unsetSkipStart()` Disable the skip-start restart search directive.

Methods inherited from class org.protempa.AbstractAbstractionDefinition
getGapFunction, setGapFunction

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

- Constructor Detail
  - LowLevelAbstractionDefinition
```
public LowLevelAbstractionDefinition(String id)
```
- Method Detail
  - getMinimumGapBetweenValues
```
public final Integer getMinimumGapBetweenValues()
```
    Returns:
    
    Returns the minimumGap.
  - getMinimumGapBetweenValuesUnits
```
public final Unit getMinimumGapBetweenValuesUnits()
```
  - setMinimumGapBetweenValues
```
public final void setMinimumGapBetweenValues(Integer minimumGapBetweenValues)
```
    Sets the minimum distance between instances of this AbstractionDefinition that are concatenable. The default value is Weight.ZERO.
  - setMinimumGapBetweenValuesUnits
```
public final void setMinimumGapBetweenValuesUnits(Unit units)
```
  - getMaximumGapBetweenValues
```
public final Integer getMaximumGapBetweenValues()
```
    Returns the minimum distance between instances of this AbstractionDefinition that are concatenable. The default value is Weight.ZERO.
    
    Returns:
    
    a Weight object.
  - getMaximumGapBetweenValuesUnits
```
public final Unit getMaximumGapBetweenValuesUnits()
```
  - setMaximumGapBetweenValues
```
public final void setMaximumGapBetweenValues(Integer maximumGapBetweenValues)
```
    Sets the maximum distance between instances of this AbstractionDefinition that are contatenable. The default value is Weight.POS_INFINITY.
  - setMaximumGapBetweenValuesUnits
```
public final void setMaximumGapBetweenValuesUnits(Unit units)
```
  - setMaximumNumberOfValues
```
public final void setMaximumNumberOfValues(int l)
```
    Sets the maximum number of sequential values to process.
    
    Parameters:
    
    l - an int. If < 0, use the equivalent field in the algorithm.
    
    See Also:
    
    Algorithm.getMaximumNumberOfValues()
  - getMaximumNumberOfValues
```
public final int getMaximumNumberOfValues()
```
    Sets the maximum number of sequential values to process.
    
    Returns:
    
    an int if < 0, use the equivalent field in the algorithm.
    
    See Also:
    
    Algorithm.getMaximumNumberOfValues()
  - setMinimumNumberOfValues
```
public final void setMinimumNumberOfValues(int l)
```
    Sets the minimum number of sequential values to process.
    
    See Also:
    
    Algorithm.getMinimumNumberOfValues()
  - getMinimumNumberOfValues
```
public final int getMinimumNumberOfValues()
```
    Gets the minimum number of sequential values to process.
    
    Returns:
    
    an int if < 0, use the equivalent field in the algorithm.
    
    See Also:
    
    Algorithm.getMinimumNumberOfValues()
  - setSkipStart
```
public final void setSkipStart(int arg)
```
    Enable the skip-start restart search directive. After a match, the next segment will have a starting value of arg more than the starting value of the matched segment.
    
    Parameters:
    
    arg - the value of the skip-start search directive, must be > 0.
  - unsetSkipStart
```
public final void unsetSkipStart()
```
    Disable the skip-start restart search directive.
  - getSkipStart
```
public final int getSkipStart()
```
    Return the value of the skip-start restart search directive.
    
    Returns:
    
    the value of the skip-start restart search directive, -1 if it is disabled.
  - setSkipEnd
```
public final void setSkipEnd(int arg)
```
    Enable the skip-end restart search directive. After a match, the next segment will have an ending value of arg more than the ending value of the matched segment.
    
    Parameters:
    
    arg - the value of the skip-end search directive, must be > 0.
  - unsetSkipEnd
```
public final void unsetSkipEnd()
```
    Disable the skip-end restart search directive.
  - getSkipEnd
```
public final int getSkipEnd()
```
    Return the value of the skip-end restart search directive.
    
    Returns:
    
    the value of the skip-end restart search directive, -1 if it is disabled.
  - setSkip
```
public final void setSkip(int arg)
```
    Enable the skip restart search directive. After a match, the next segment will have a starting and ending value of arg more than the ending value of the matched segment.
    
    Parameters:
    
    arg - the value of the skip restart search directive, must be > 0.
  - unsetSkip
```
public final void unsetSkip()
```
    Disable the skip restart search directive.
  - getSkip
```
public final int getSkip()
```
    Return the value of the skip restart search directive.
    
    Returns:
    
    the value of the skip restart search directive, -1 if it is disabled.
  - setMaxOverlapping
```
public final void setMaxOverlapping(int arg)
```
    Enable the max-overlapping restart search directive. After a match, the next segment will have a starting and ending value of arg - 1 less than the ending value of the matched segment.
    
    Parameters:
    
    arg - the value of the max-overlapping restart search directive, must be > 0.
  - unsetMaxOverlapping
```
public final void unsetMaxOverlapping()
```
    Disable the max-overlapping restart search directive.
  - getMaxOverlapping
```
public final int getMaxOverlapping()
```
    Return the value of the max-overlapping restart search directive.
    
    Returns:
    
    the value of the max-overlapping restart serach directive, -1 if it is disabled.
  - getSlidingWindowWidthMode
```
public SlidingWindowWidthMode getSlidingWindowWidthMode()
```
    Gets the sliding window width mode. The default value is SlidingWindowWidthMode.ALL.
    
    Returns:
    
    a SlidingWindowWidthMode object (will never be null).
  - setSlidingWindowWidthMode
```
public void setSlidingWindowWidthMode(SlidingWindowWidthMode slidingWindowWidthMode)
```
    Sets the sliding window width mode. If the algorithmId is null, a value of SlidingWindowWidthMode.DEFAULT is not permitted.
    
    Parameters:
    
    slidingWindowWidthMode - a SlidingWindowWidthMode. Cannot be null.
  - addValueDefinition
```
public boolean addValueDefinition(LowLevelAbstractionValueDefinition d)
```
  - getValueDefinitions
```
public List<LowLevelAbstractionValueDefinition> getValueDefinitions()
```
  - getValueDefinitions
```
public LowLevelAbstractionValueDefinition[] getValueDefinitions(String id)
```
  - addPrimitiveParameterId
```
public boolean addPrimitiveParameterId(String paramId)
```
    Adds a primitive parameter from which this abstraction is inferred.
    
    Parameters:
    
    paramId - a primitive parameter id String.
    
    Returns:
    
    true if adding the parameter id was successful, false otherwise (e.g., paramId was null).
  - removePrimitiveParameterId
```
public boolean removePrimitiveParameterId(String paramId)
```
    Removes a primitive parameter from which this abstraction is inferred.
    
    Parameters:
    
    paramId - a primitive parameter id String.
    
    Returns:
    
    true if removingg the parameter id was successful, false otherwise (e.g., paramId was null or not previously added to this abstraction definition).
  - 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.
  - setValueType
```
public void setValueType(ValueType c)
```
  - getValueType
```
public ValueType getValueType()
```
    Specified by:
    
    getValueType in interface ParameterDefinition
  - accept
```
public void accept(PropositionDefinitionVisitor processor)
```
    Description copied from interface: PropositionDefinitionVisitable
    
    Performs some processing on a proposition definition.
    
    Specified by:
    
    accept in interface PropositionDefinitionVisitable
  - acceptChecked
```
public void acceptChecked(PropositionDefinitionCheckedVisitor processor)
                   throws ProtempaException
```
    Description copied from interface: PropositionDefinitionCheckedVisitable
    
    Performs some processing on this proposition definition.
    
    Specified by:
    
    acceptChecked in interface PropositionDefinitionCheckedVisitable
    
    Throws:
    
    ProtempaException
  - setMinimumDuration
```
public final void setMinimumDuration(Integer minDuration)
```
  - setMinimumDurationUnits
```
public final void setMinimumDurationUnits(Unit minDurationUnits)
```
  - setMaximumDuration
```
public final void setMaximumDuration(Integer maxDuration)
```
  - setMaximumDurationUnits
```
public final void setMaximumDurationUnits(Unit maxDurationUnits)
```
  - getMinimumDuration
```
public final Integer getMinimumDuration()
```
  - getMinimumDurationUnits
```
public final Unit getMinimumDurationUnits()
```
  - getMaximumDuration
```
public final Integer getMaximumDuration()
```
  - getMaximumDurationUnits
```
public final Unit getMaximumDurationUnits()
```
  - getAlgorithmId
```
public String getAlgorithmId()
```
  - setAlgorithmId
```
public void setAlgorithmId(String algorithmId)
```
  - 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 low-level abstraction is concatenable.
    
    Parameters:
    
    concatenable - true if concatenable, false if not.
  - isConcatenable
```
public boolean isConcatenable()
```
    Returns whether this type of low-level abstraction is concatenable. The default for low-level abstractions is concatenable.
    
    Specified by:
    
    isConcatenable in interface PropositionDefinition
    
    Returns:
    
    true if concatenable, false if not.
  - isSolid
```
public boolean isSolid()
```
    Returns whether intervals of this type are solid, i.e., never hold over properly overlapping intervals. By definition, low-level abstraction intervals are solid.
    
    Specified by:
    
    isSolid in interface PropositionDefinition
    
    Returns:
    
    true.
  - getContextId
```
public String getContextId()
```
  - setContextId
```
public void setContextId(String contextId)
```
  - recalculateChildren
```
protected void recalculateChildren()
```
    Specified by:
    
    recalculateChildren in class AbstractPropositionDefinition
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class AbstractAbstractionDefinition
  - getId
```
public String getId()
```

Class LowLevelAbstractionDefinition

Field Summary

Fields inherited from class org.protempa.AbstractPropositionDefinition

Constructor Summary

Method Summary

Methods inherited from class org.protempa.AbstractAbstractionDefinition

Methods inherited from class org.protempa.AbstractPropositionDefinition

Methods inherited from class java.lang.Object

Methods inherited from interface org.protempa.PropositionDefinition

Methods inherited from interface org.protempa.AbstractionDefinition

Constructor Detail

LowLevelAbstractionDefinition

Method Detail

getMinimumGapBetweenValues

getMinimumGapBetweenValuesUnits

setMinimumGapBetweenValues

setMinimumGapBetweenValuesUnits

getMaximumGapBetweenValues

getMaximumGapBetweenValuesUnits

setMaximumGapBetweenValues

setMaximumGapBetweenValuesUnits

setMaximumNumberOfValues

getMaximumNumberOfValues

setMinimumNumberOfValues

getMinimumNumberOfValues

setSkipStart

unsetSkipStart

getSkipStart

setSkipEnd

unsetSkipEnd

getSkipEnd

setSkip

unsetSkip

getSkip

setMaxOverlapping

unsetMaxOverlapping

getMaxOverlapping

getSlidingWindowWidthMode

setSlidingWindowWidthMode

addValueDefinition

getValueDefinitions

getValueDefinitions

addPrimitiveParameterId

removePrimitiveParameterId

getAbstractedFrom

setValueType

getValueType

accept

acceptChecked

setMinimumDuration

setMinimumDurationUnits

setMaximumDuration

setMaximumDurationUnits

getMinimumDuration

getMinimumDurationUnits

getMaximumDuration

getMaximumDurationUnits

getAlgorithmId

setAlgorithmId

reset

setConcatenable

isConcatenable

isSolid

getContextId

setContextId

recalculateChildren

toString

getId