Class KonceptDefinition.Builder

java.lang.Object
network.ike.docs.koncept.KonceptDefinition.Builder
Enclosing class:
KonceptDefinition
public static class KonceptDefinition.Builder extends Object
Builder for constructing KonceptDefinition instances from parsed YAML or programmatic sources.

  • Constructor Details

    • Builder

      public Builder()
      Creates a new empty builder.

  • Method Details

    • identifier

      public KonceptDefinition.Builder identifier(String identifier)
      Sets the CamelCase identifier.
      Parameters:
      identifier - the identifier to set
      Returns:
      this builder

    • label

      public KonceptDefinition.Builder label(String label)
      Sets the human-readable label.
      Parameters:
      label - the label to set
      Returns:
      this builder

    • definition

      public KonceptDefinition.Builder definition(String definition)
      Sets the natural language definition text.
      Parameters:
      definition - the definition to set
      Returns:
      this builder

    • axiom

      public KonceptDefinition.Builder axiom(String axiom)
      Sets the description logic axiom string.
      Parameters:
      axiom - the axiom to set
      Returns:
      this builder

    • sctid

      public KonceptDefinition.Builder sctid(String sctid)
      Sets the SNOMED CT concept identifier.
      Parameters:
      sctid - the SNOMED CT identifier to set
      Returns:
      this builder

    • iri

      public KonceptDefinition.Builder iri(String iri)
      Sets the OWL IRI for the concept.
      Parameters:
      iri - the IRI to set
      Returns:
      this builder

    • uuids

      public KonceptDefinition.Builder uuids(List<String> uuids)
      Sets the explicit Tinkar PublicId UUIDs (in datastore order) used to compute the Komet identicon.
      Parameters:
      uuids - the UUID strings to set
      Returns:
      this builder

    • kind

      public KonceptDefinition.Builder kind(String kind)
      Sets the component kind (concept, description, semantic, pattern, stamp, unknown); null or absent means concept.
      Parameters:
      kind - the kind name to set
      Returns:
      this builder

    • broader

      public KonceptDefinition.Builder broader(List<String> broader)
      Sets the identifiers of this koncept's supertypes (is-a parents).
      Parameters:
      broader - the parent identifiers to set
      Returns:
      this builder

    • status

      public KonceptDefinition.Builder status(String status)
      Sets the logical-definition status name (defined, primitive, root); null or absent means no stated definition.
      Parameters:
      status - the status name to set
      Returns:
      this builder

    • state

      public KonceptDefinition.Builder state(String state)
      Sets the lifecycle state of the koncept's latest version (inactive renders the retired treatment); null or absent means active.
      Parameters:
      state - the state name to set
      Returns:
      this builder

    • section

      public KonceptDefinition.Builder section(String section)
      Sets the stable section-grouping key computed against the live knowledge base.
      Parameters:
      section - the section key to set
      Returns:
      this builder

    • since

      public KonceptDefinition.Builder since(String since)
      Sets the earliest stamp time of this koncept's own version chain.
      Parameters:
      since - the formatted time to set
      Returns:
      this builder

    • comments

      public KonceptDefinition.Builder comments(List<String> comments)
      Sets the text of every currently active comment attached to this koncept.
      Parameters:
      comments - the comment texts to set
      Returns:
      this builder

    • retiredComments

      public KonceptDefinition.Builder retiredComments(List<KonceptDefinition.RetiredComment> retiredComments)
      Sets the prior text and retirement time of comments superseded by an inactive version.
      Parameters:
      retiredComments - the retired comments to set
      Returns:
      this builder

    • seeAlso

      public KonceptDefinition.Builder seeAlso(List<String> seeAlso)
      Sets the identifiers of related koncepts (a javadoc-@see analog).
      Parameters:
      seeAlso - the related identifiers to set
      Returns:
      this builder

    • narrative

      public KonceptDefinition.Builder narrative(String narrative)
      Sets the curated, long-form AsciiDoc prose for this koncept.
      Parameters:
      narrative - the AsciiDoc source to set
      Returns:
      this builder

    • referencedComponentMeaning

      public KonceptDefinition.Builder referencedComponentMeaning(String referencedComponentMeaning)
      Sets a kind: pattern koncept's own referenced-component meaning concept identifier.
      Parameters:
      referencedComponentMeaning - the referenced-component meaning identifier to set
      Returns:
      this builder

    • referencedComponentPurpose

      public KonceptDefinition.Builder referencedComponentPurpose(String referencedComponentPurpose)
      Sets a kind: pattern koncept's own referenced-component purpose concept identifier.
      Parameters:
      referencedComponentPurpose - the referenced-component purpose identifier to set
      Returns:
      this builder

    • referencedComponentExample

      public KonceptDefinition.Builder referencedComponentExample(String referencedComponentExample)
      Sets a kind: pattern koncept's referenced-component example — the referenced component of a real semantic of this pattern already in the knowledge base.
      Parameters:
      referencedComponentExample - the referenced-component example to set
      Returns:
      this builder

    • fields

      public KonceptDefinition.Builder fields(List<KonceptDefinition.PatternField> fields)
      Sets a kind: pattern koncept's own field definitions, in declared order.
      Parameters:
      fields - the field definitions to set
      Returns:
      this builder

    • build

      public KonceptDefinition build()
      Builds an immutable KonceptDefinition from this builder's state.
      Returns:
      the constructed definition
      Throws:
      IllegalStateException - if identifier is null or blank