AbstractPropositionDefinition (Protempa Framework 5.0-Beta-8 API)

java.lang.Object
- org.protempa.AbstractPropositionDefinition

All Implemented Interfaces:

Serializable, PropositionDefinition, PropositionDefinitionCheckedVisitable, PropositionDefinitionVisitable

Direct Known Subclasses:

AbstractAbstractionDefinition, ConstantDefinition, ContextDefinition, EventDefinition, PrimitiveParameterDefinition
```
public abstract class AbstractPropositionDefinition
extends Object
implements PropositionDefinition
```
Abstract base class for all knowledge definition classes. FIXME We support event, abstraction, and primitive parameter definitions with the same name, yet Protempa's public API assumes that they all share the same namespace. This needs to be fixed. I'm leaning toward having all knowledge definitions share the same namespace, in which case, no changes to Protempa's API would be required, and the duplicate id checking could all occur in this class in a concrete implementation of setId0().

Author:

Andrew Post

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected String[] children

protected static String CHILDREN_PROPERTY

Fields
Modifier and Type	Field and Description
`protected String[]`	`children`
`protected static String`	`CHILDREN_PROPERTY`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`PropertyDefinition`	`propertyDefinition(String id)`
`protected abstract void`	`recalculateChildren()`
`ReferenceDefinition`	`referenceDefinition(String name)` Returns the reference definition with the given name.
`void`	`reset()` Resets this proposition definition to default values.
`void`	`setAbbreviatedDisplayName(String abbrev)` Sets this knowledge definition's abbreviated display name.
`void`	`setAccessed(Date accessed)`
`void`	`setAttributes(Attribute[] attributes)`
`void`	`setCreated(Date created)`
`void`	`setDescription(String description)`
`void`	`setDisplayName(String displayName)` Sets this proposition definition's human-readable display name.
`void`	`setDownloaded(Date downloaded)`
`void`	`setInDataSource(boolean inDataSource)`
`void`	`setInverseIsA(String... inverseIsA)` Sets the children of this proposition definition.
`void`	`setPropertyDefinitions(PropertyDefinition... propertyDefinitions)`
`void`	`setPropositionId(String propId)` Sets the proposition id of propositions derived by this proposition definition.
`void`	`setReferenceDefinitions(ReferenceDefinition... referenceDefinitions)`
`void`	`setSourceId(SourceId sourceId)`
`void`	`setTermIds(String... termIds)` Assigns this proposition with associated `TermDefinition` ids.
`void`	`setUpdated(Date updated)`
`void`	`setVersion(String version)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.protempa.PropositionDefinition
isConcatenable, isSolid

Methods inherited from interface org.protempa.PropositionDefinitionVisitable
accept

Methods inherited from interface org.protempa.PropositionDefinitionCheckedVisitable
acceptChecked

- Field Detail
  - CHILDREN_PROPERTY
```
protected static final String CHILDREN_PROPERTY
```
    See Also:
    
    Constant Field Values
  - children
```
protected String[] children
```
- Method Detail
  - getId
```
public final String getId()
```
    Description copied from interface: PropositionDefinition
    
    This proposition definition's id.
    
    Specified by:
    
    getId in interface PropositionDefinition
    
    Returns:
    
    a String, guaranteed not to be null.
  - getPropositionId
```
public final String getPropositionId()
```
    Description copied from interface: PropositionDefinition
    
    The proposition id of propositions derived by this proposition definition. The default value is the value of this proposition definition's id field.
    
    Specified by:
    
    getPropositionId in interface PropositionDefinition
    
    Returns:
    
    a proposition id.
  - setPropositionId
```
public final void setPropositionId(String propId)
```
    Sets the proposition id of propositions derived by this proposition definition.
    
    Parameters:
    
    propId - a proposition id. Pass in null to set the value of this field to the value of this proposition definition's id field.
  - getAbbreviatedDisplayName
```
public final String getAbbreviatedDisplayName()
```
    Description copied from interface: PropositionDefinition
    
    This proposition definition's abbreviated display name.
    
    Specified by:
    
    getAbbreviatedDisplayName in interface PropositionDefinition
    
    Returns:
    
    a String. Guaranteed not null.
  - setAbbreviatedDisplayName
```
public final void setAbbreviatedDisplayName(String abbrev)
```
    Sets this knowledge definition's abbreviated display name.
    
    Parameters:
    
    abbrev - an abbreviated display name String.
  - getDisplayName
```
public final String getDisplayName()
```
    Description copied from interface: PropositionDefinition
    
    This proposition definition's display name.
    
    Specified by:
    
    getDisplayName in interface PropositionDefinition
    
    Returns:
    
    a String. Guaranteed not null.
  - setDisplayName
```
public final void setDisplayName(String displayName)
```
    Sets this proposition definition's human-readable display name.
    
    Parameters:
    
    displayName - a display name String.
  - getDescription
```
public String getDescription()
```
    Description copied from interface: PropositionDefinition
    
    A longer description of the proposition definition.
    
    Specified by:
    
    getDescription in interface PropositionDefinition
    
    Returns:
    
    a String. Guaranteed not null.
  - setDescription
```
public void setDescription(String description)
```
  - getInverseIsA
```
public String[] getInverseIsA()
```
    Description copied from interface: PropositionDefinition
    
    Returns the ids of the proposition definitions that have an is-a relationship with this proposition definition.
    
    Specified by:
    
    getInverseIsA in interface PropositionDefinition
    
    Returns:
    
    a String[] of proposition definition ids.
  - setInverseIsA
```
public void setInverseIsA(String... inverseIsA)
```
    Sets the children of this proposition definition.
    
    Parameters:
    
    inverseIsA - a String[] of proposition definition ids. No null or duplicate elements allowed.
  - getChildren
```
public String[] getChildren()
```
    Description copied from interface: PropositionDefinition
    
    Returns the ids of this proposition definition's children. These include proposition definitions with abstracted-from, inverse-isa, and has-part relations.
    
    Specified by:
    
    getChildren in interface PropositionDefinition
    
    Returns:
    
    an array of Strings, guaranteed not null.
  - getTermIds
```
public final String[] getTermIds()
```
    Description copied from interface: PropositionDefinition
    
    Gets the ids of the TermDefinitions associated with this proposition definition.
    
    Specified by:
    
    getTermIds in interface PropositionDefinition
    
    Returns:
    
    the term ids as an array of Strings.
  - setTermIds
```
public final void setTermIds(String... termIds)
```
    Assigns this proposition with associated TermDefinition ids.
    
    Parameters:
    
    termId - a term definition id String. No null or duplicate elements allowed.
  - getPropertyDefinitions
```
public final PropertyDefinition[] getPropertyDefinitions()
```
    Specified by:
    
    getPropertyDefinitions in interface PropositionDefinition
  - propertyDefinition
```
public final PropertyDefinition propertyDefinition(String id)
```
    Specified by:
    
    propertyDefinition in interface PropositionDefinition
  - setPropertyDefinitions
```
public final void setPropertyDefinitions(PropertyDefinition... propertyDefinitions)
```
  - getReferenceDefinitions
```
public final ReferenceDefinition[] getReferenceDefinitions()
```
    Specified by:
    
    getReferenceDefinitions in interface PropositionDefinition
  - referenceDefinition
```
public final ReferenceDefinition referenceDefinition(String name)
```
    Description copied from interface: PropositionDefinition
    
    Returns the reference definition with the given name.
    
    Specified by:
    
    referenceDefinition in interface PropositionDefinition
    
    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
  - setReferenceDefinitions
```
public final void setReferenceDefinitions(ReferenceDefinition... referenceDefinitions)
```
  - getInDataSource
```
public boolean getInDataSource()
```
    Specified by:
    
    getInDataSource in interface PropositionDefinition
  - setInDataSource
```
public void setInDataSource(boolean inDataSource)
```
  - getSourceId
```
public SourceId getSourceId()
```
    Specified by:
    
    getSourceId in interface PropositionDefinition
  - setSourceId
```
public void setSourceId(SourceId sourceId)
```
  - getAccessed
```
public Date getAccessed()
```
    Description copied from interface: PropositionDefinition
    
    Returns the timestamp of when this proposition definition was accessed from the knowledge source.
    
    Specified by:
    
    getAccessed in interface PropositionDefinition
    
    Returns:
    
    a Date. Guaranteed not null.
  - getCreated
```
public Date getCreated()
```
    Description copied from interface: PropositionDefinition
    
    Returns the timestamp of when this proposition definition was created, if the knowledge source backend maintains this information.
    
    Specified by:
    
    getCreated in interface PropositionDefinition
    
    Returns:
    
    a Date, or null if the knowledge source backend does not maintain created timestamp information.
  - getUpdated
```
public Date getUpdated()
```
    Description copied from interface: PropositionDefinition
    
    Returns the timestamp of when this proposition definition was last updated, if the knowledge source backend maintains this information.
    
    Specified by:
    
    getUpdated in interface PropositionDefinition
    
    Returns:
    
    a Date, or null if the knowledge source backend does not maintain last updated timestamp information.
  - setAccessed
```
public void setAccessed(Date accessed)
```
  - setCreated
```
public void setCreated(Date created)
```
  - setUpdated
```
public void setUpdated(Date updated)
```
  - getVersion
```
public String getVersion()
```
    Description copied from interface: PropositionDefinition
    
    Returns the version number of this proposition definition, for knowledge source backends that maintain version information.
    
    Specified by:
    
    getVersion in interface PropositionDefinition
    
    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.
  - setVersion
```
public void setVersion(String version)
```
  - getDownloaded
```
public Date getDownloaded()
```
    Description copied from interface: PropositionDefinition
    
    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.
    
    Specified by:
    
    getDownloaded in interface PropositionDefinition
    
    Returns:
    
    a Date, or null if no download timestamp information is available.
  - setDownloaded
```
public void setDownloaded(Date downloaded)
```
  - getAttributes
```
public Attribute[] getAttributes()
```
    Specified by:
    
    getAttributes in interface PropositionDefinition
  - setAttributes
```
public void setAttributes(Attribute[] attributes)
```
  - attribute
```
public Attribute attribute(String name)
```
    Specified by:
    
    attribute in interface PropositionDefinition
  - reset
```
public void reset()
```
    Resets this proposition definition to default values.
  - recalculateChildren
```
protected abstract void recalculateChildren()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class AbstractPropositionDefinition

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.protempa.PropositionDefinition

Methods inherited from interface org.protempa.PropositionDefinitionVisitable

Methods inherited from interface org.protempa.PropositionDefinitionCheckedVisitable

Field Detail

CHILDREN_PROPERTY

children

Method Detail

getId

getPropositionId

setPropositionId

getAbbreviatedDisplayName

setAbbreviatedDisplayName

getDisplayName

setDisplayName

getDescription

setDescription

getInverseIsA

setInverseIsA

getChildren

getTermIds

setTermIds

getPropertyDefinitions

propertyDefinition

setPropertyDefinitions

getReferenceDefinitions

referenceDefinition

setReferenceDefinitions

getInDataSource

setInDataSource

getSourceId

setSourceId

getAccessed

getCreated

getUpdated

setAccessed

setCreated

setUpdated

getVersion

setVersion

getDownloaded

setDownloaded

getAttributes

setAttributes

attribute

reset

recalculateChildren

toString