Record Class KonceptDefinition

java.lang.Object
java.lang.Record
network.ike.docs.koncept.KonceptDefinition
Record Components:
identifier - CamelCase identifier used in markup (e.g., "HeartFailure")
label - Human-readable label (e.g., "Heart Failure")
definition - Natural language definition text
axiom - Description logic axiom string using Unicode DL symbols
sctid - Optional SNOMED CT concept identifier
iri - Optional OWL IRI for the concept
uuids - Optional explicit Tinkar PublicId UUIDs, in datastore order, used to compute the Komet identicon; when absent the identicon is derived from sctid
kind - Optional component kind (concept, description, semantic, pattern, stamp, unknown); null or absent means concept (the bare default)
broader - Optional identifiers of this koncept's supertypes (is-a parents); the glossary renders them as parent chips and inverts them across the source to render each koncept's children
status - Optional logical-definition status from the stated EL++ expression (defined, primitive, root); null or absent means no stated definition — the badge stays bare (ike-issues#742 design amendment, #940). Multi-parent is not a status: it is derived from broader's size
state - Optional lifecycle state of the koncept's latest version; inactive renders the retired treatment — struck-through label in the retired colour (#742 retired parity, #864). Absent means active
section - Optional stable grouping key computed against the live knowledge base (a taxonomy-subtree root's own identifier, or a positional ResidualN/Unclassified bucket); the grouped glossary mode sections the document by this field
since - Optional earliest stamp time of this koncept's own version chain, formatted as recorded by the knowledge base
comments - Optional text of every currently active free-text comment attached to this koncept
retiredComments - Optional prior text and retirement time of a comment that has since been superseded by an inactive version — "maybe in some cases," per the source data; absent far more often than present
seeAlso - Optional identifiers of related koncepts (a javadoc-@see analog); no Tinkar association/replacement pattern is wired anywhere today, so this is reserved plumbing, not yet populated by any known source
narrative - Optional curated, long-form AsciiDoc prose for this koncept (as opposed to the short definition gloss) — real AsciiDoc source, including embedded k: chip references, meant to be spliced into a document and re-parsed (see the koncept-narrative block macro), not rendered as flat text
referencedComponentMeaning - Optional identifier of a kind: pattern koncept's own referenced-component meaning concept — what a semantic of this pattern's referenced component means (Tinkar's wire schema calls this pair ReferencedComponentMeaning/Purpose; the Java entity API calls it semanticMeaning/Purpose — both names describe the same field); null for a concept
referencedComponentPurpose - Optional identifier of a kind: pattern koncept's own referenced-component purpose concept; null for a concept
referencedComponentExample - Optional referenced component of a real, deterministically chosen semantic of this pattern already in the knowledge base — a koncept identifier when it resolves to one, otherwise its plain display text; null for a concept, or for a pattern with no semantics yet
fields - Optional field definitions of a kind: pattern koncept, in declared order — each field's own meaning, purpose, and data-type koncept identifiers; empty for a concept
public record KonceptDefinition(String identifier, String label, String definition, String axiom, String sctid, String iri, List<String> uuids, String kind, List<String> broader, String status, String state, String section, String since, List<String> comments, List<KonceptDefinition.RetiredComment> retiredComments, List<String> seeAlso, String narrative, String referencedComponentMeaning, String referencedComponentPurpose, String referencedComponentExample, List<KonceptDefinition.PatternField> fields) extends Record
Immutable definition of a Koncept, including natural language definition, description logic axiom, and optional terminology identifiers.

  • Constructor Details

  • Method Details

    • konceptStatus

      public KonceptStatus konceptStatus()
      The logical-definition status as the typed vocabulary — KonceptStatus.NONE when status() is absent or unrecognised.
      Returns:
      the resolved status, never null

    • isMultiParent

      public boolean isMultiParent()
      Whether this koncept has more than one stated is-a parent — the structural property the badge renders as the appended "\u22ce" fork.
      Returns:
      true when broader() lists more than one parent

    • isInactive

      public boolean isInactive()
      Whether this koncept's latest version is inactive (retired) — the badge renders the retired treatment (#742 retired parity).
      Returns:
      true when state() is inactive

    • modelFeatures

      public List<KonceptDefinition.ModelFeature> modelFeatures()
      This pattern's Model Features in presentation order — the single source of truth behind every shape rendering (the koncept-pattern-table block macro and the glossary's pattern-shape table): the referenced component, then each declared field in order.
      Returns:
      the Model Features, or an empty list for a koncept with no shape at all

    • builder

      public static KonceptDefinition.Builder builder()
      Creates a new builder for constructing KonceptDefinition instances.
      Returns:
      a new builder

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • identifier

      public String identifier()
      Returns the value of the identifier record component.
      Returns:
      the value of the identifier record component

    • label

      public String label()
      Returns the value of the label record component.
      Returns:
      the value of the label record component

    • definition

      public String definition()
      Returns the value of the definition record component.
      Returns:
      the value of the definition record component

    • axiom

      public String axiom()
      Returns the value of the axiom record component.
      Returns:
      the value of the axiom record component

    • sctid

      public String sctid()
      Returns the value of the sctid record component.
      Returns:
      the value of the sctid record component

    • iri

      public String iri()
      Returns the value of the iri record component.
      Returns:
      the value of the iri record component

    • uuids

      public List<String> uuids()
      Returns the value of the uuids record component.
      Returns:
      the value of the uuids record component

    • kind

      public String kind()
      Returns the value of the kind record component.
      Returns:
      the value of the kind record component

    • broader

      public List<String> broader()
      Returns the value of the broader record component.
      Returns:
      the value of the broader record component

    • status

      public String status()
      Returns the value of the status record component.
      Returns:
      the value of the status record component

    • state

      public String state()
      Returns the value of the state record component.
      Returns:
      the value of the state record component

    • section

      public String section()
      Returns the value of the section record component.
      Returns:
      the value of the section record component

    • since

      public String since()
      Returns the value of the since record component.
      Returns:
      the value of the since record component

    • comments

      public List<String> comments()
      Returns the value of the comments record component.
      Returns:
      the value of the comments record component

    • retiredComments

      public List<KonceptDefinition.RetiredComment> retiredComments()
      Returns the value of the retiredComments record component.
      Returns:
      the value of the retiredComments record component

    • seeAlso

      public List<String> seeAlso()
      Returns the value of the seeAlso record component.
      Returns:
      the value of the seeAlso record component

    • narrative

      public String narrative()
      Returns the value of the narrative record component.
      Returns:
      the value of the narrative record component

    • referencedComponentMeaning

      public String referencedComponentMeaning()
      Returns the value of the referencedComponentMeaning record component.
      Returns:
      the value of the referencedComponentMeaning record component

    • referencedComponentPurpose

      public String referencedComponentPurpose()
      Returns the value of the referencedComponentPurpose record component.
      Returns:
      the value of the referencedComponentPurpose record component

    • referencedComponentExample

      public String referencedComponentExample()
      Returns the value of the referencedComponentExample record component.
      Returns:
      the value of the referencedComponentExample record component

    • fields

      public List<KonceptDefinition.PatternField> fields()
      Returns the value of the fields record component.
      Returns:
      the value of the fields record component