PropositionDefinition (Protempa Framework 4.1 API)

All Superinterfaces:

PropositionDefinitionCheckedVisitable, PropositionDefinitionVisitable, Serializable

All Known Subinterfaces:

AbstractionDefinition, ParameterDefinition, TemporalPropositionDefinition

All Known Implementing Classes:

AbstractAbstractionDefinition, AbstractPropositionDefinition, CompoundLowLevelAbstractionDefinition, ConstantDefinition, ContextDefinition, EventDefinition, HighLevelAbstractionDefinition, LowLevelAbstractionDefinition, PrimitiveParameterDefinition, SequentialTemporalPatternDefinition, SliceDefinition
```
public interface PropositionDefinition
extends Serializable, PropositionDefinitionVisitable, PropositionDefinitionCheckedVisitable
```
Foundation type for all objects that go in a Knowledge Base. Since knowledge bases are serializable, then all knowledge base objects must be serializable too. Every knowledge definition object has an unique id.

Author:

Andrew Post

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addPropertyChangeListener(PropertyChangeListener listener)`
`void`	`addPropertyChangeListener(String propertyName, PropertyChangeListener listener)`
`Attribute`	`attribute(String name)`
`String`	`getAbbreviatedDisplayName()` This proposition definition's abbreviated display name.
`Date`	`getAccessed()` Returns the timestamp of when this proposition definition was accessed from the knowledge source.
`Attribute[]`	`getAttributes()`
`String[]`	`getChildren()` Returns the ids of this proposition definition's children.
`Date`	`getCreated()` Returns the timestamp of when this proposition definition was created, if the knowledge source backend maintains this information.
`String`	`getDescription()` A longer description of the proposition definition.
`String`	`getDisplayName()` This proposition definition's display name.
`Date`	`getDownloaded()` Returns the timestamp of when this proposition definition's information was downloaded from its source, e.g., a terminology standard, if such information is available.
`String`	`getId()` This proposition definition's id.
`boolean`	`getInDataSource()`
`String[]`	`getInverseIsA()` Returns the ids of the proposition definitions that have an is-a relationship with this proposition definition.
`PropertyDefinition[]`	`getPropertyDefinitions()`
`String`	`getPropositionId()` The proposition id of propositions derived by this proposition definition.
`ReferenceDefinition[]`	`getReferenceDefinitions()`
`SourceId`	`getSourceId()`
`String[]`	`getTermIds()` Gets the ids of the `TermDefinition`s associated with this proposition definition.
`Date`	`getUpdated()` Returns the timestamp of when this proposition definition was last updated, if the knowledge source backend maintains this information.
`String`	`getVersion()` Returns the version number of this proposition definition, for knowledge source backends that maintain version information.
`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.
`PropertyDefinition`	`propertyDefinition(String name)`
`ReferenceDefinition`	`referenceDefinition(String name)` Returns the reference definition with the given name.
`void`	`removePropertyChangeListener(PropertyChangeListener listener)`
`void`	`removePropertyChangeListener(String proeprtyName, PropertyChangeListener listener)`

Methods inherited from interface org.protempa.PropositionDefinitionVisitable
accept

Methods inherited from interface org.protempa.PropositionDefinitionCheckedVisitable
acceptChecked

- Method Detail
  - getDisplayName
```
String getDisplayName()
```
    This proposition definition's display name.
    
    Returns:
    
    a String. Guaranteed not null.
  - getAbbreviatedDisplayName
```
String getAbbreviatedDisplayName()
```
    This proposition definition's abbreviated display name.
    
    Returns:
    
    a String. Guaranteed not null.
  - getDescription
```
String getDescription()
```
    A longer description of the proposition definition.
    
    Returns:
    
    a String. Guaranteed not null.
  - getId
```
String getId()
```
    This proposition definition's id.
    
    Returns:
    
    a String, guaranteed not to be null.
  - getPropositionId
```
String getPropositionId()
```
    The proposition id of propositions derived by this proposition definition. The default value is the value of this proposition definition's id field.
    
    Returns:
    
    a proposition id.
  - getChildren
```
String[] getChildren()
```
    Returns the ids of this proposition definition's children. These include proposition definitions with abstracted-from, inverse-isa, and has-part relations.
    
    Returns:
    
    an array of Strings, guaranteed not null.
  - getInverseIsA
```
String[] getInverseIsA()
```
    Returns the ids of the proposition definitions that have an is-a relationship with this proposition definition.
    
    Returns:
    
    a String[] of proposition definition ids.
  - isConcatenable
```
boolean isConcatenable()
```
    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.
    
    Returns:
    
    true if concatenable, false if not.
  - isSolid
```
boolean isSolid()
```
    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.
    
    Returns:
    
    true if solid, false if not.
  - getTermIds
```
String[] getTermIds()
```
    Gets the ids of the TermDefinitions associated with this proposition definition.
    
    Returns:
    
    the term ids as an array of Strings.
  - getPropertyDefinitions
```
PropertyDefinition[] getPropertyDefinitions()
```
  - propertyDefinition
```
PropertyDefinition propertyDefinition(String name)
```
  - getReferenceDefinitions
```
ReferenceDefinition[] getReferenceDefinitions()
```
  - referenceDefinition
```
ReferenceDefinition referenceDefinition(String name)
```
    Returns the reference definition with the given name.
    
    Parameters:
    
    name - a reference definition name String.
    
    Returns:
    
    the ReferenceDefinition with the given name, or null if this proposition definition has no reference definition with the given name
  - getInDataSource
```
boolean getInDataSource()
```
  - addPropertyChangeListener
```
void addPropertyChangeListener(PropertyChangeListener listener)
```
  - removePropertyChangeListener
```
void removePropertyChangeListener(PropertyChangeListener listener)
```
  - addPropertyChangeListener
```
void addPropertyChangeListener(String propertyName,
                               PropertyChangeListener listener)
```
  - removePropertyChangeListener
```
void removePropertyChangeListener(String proeprtyName,
                                  PropertyChangeListener listener)
```
  - getSourceId
```
SourceId getSourceId()
```
  - getVersion
```
String getVersion()
```
    Returns the version number of this proposition definition, for knowledge source backends that maintain version information.
    
    Returns:
    
    a version String, or null if the knowledge source backend does not maintain version information. The string's format is specified to the knowledge source backend and the original information source.
  - getDownloaded
```
Date getDownloaded()
```
    Returns the timestamp of when this proposition definition's information was downloaded from its source, e.g., a terminology standard, if such information is available.
    
    Returns:
    
    a Date, or null if no download timestamp information is available.
  - getAccessed
```
Date getAccessed()
```
    Returns the timestamp of when this proposition definition was accessed from the knowledge source.
    
    Returns:
    
    a Date. Guaranteed not null.
  - getCreated
```
Date getCreated()
```
    Returns the timestamp of when this proposition definition was created, if the knowledge source backend maintains this information.
    
    Returns:
    
    a Date, or null if the knowledge source backend does not maintain created timestamp information.
  - getUpdated
```
Date getUpdated()
```
    Returns the timestamp of when this proposition definition was last updated, if the knowledge source backend maintains this information.
    
    Returns:
    
    a Date, or null if the knowledge source backend does not maintain last updated timestamp information.
  - getAttributes
```
Attribute[] getAttributes()
```
  - attribute
```
Attribute attribute(String name)
```

Interface PropositionDefinition

Method Summary

Methods inherited from interface org.protempa.PropositionDefinitionVisitable

Methods inherited from interface org.protempa.PropositionDefinitionCheckedVisitable

Method Detail

getDisplayName

getAbbreviatedDisplayName

getDescription

getId

getPropositionId

getChildren

getInverseIsA

isConcatenable

isSolid

getTermIds

getPropertyDefinitions

propertyDefinition

getReferenceDefinitions

referenceDefinition

getInDataSource

addPropertyChangeListener

removePropertyChangeListener

addPropertyChangeListener

removePropertyChangeListener

getSourceId

getVersion

getDownloaded

getAccessed

getCreated

getUpdated

getAttributes

attribute