Record Class KonceptDefinition.ModelFeature

java.lang.Object

java.lang.Record

network.ike.docs.koncept.KonceptDefinition.ModelFeature

Record Components:

label - the feature's display label — Referenced component with the generic any-component phrase, or Field N

meaning - the feature's meaning koncept identifier, or null

purpose - the feature's purpose koncept identifier, or null

dataType - the feature's data-type koncept identifier, or null for the referenced component, which has none

example - the feature's live example value, or null when the extraction found no example semantic

defaultValue - the feature's default value from the pattern's default value semantic, or null when the pattern has none — always null for the referenced component, whose referenced component on the defaults semantic is the defaults attachment concept itself, not a documentable value

Enclosing class:

KonceptDefinition

public static record KonceptDefinition.ModelFeature(String label, String meaning, String purpose, String dataType, String example, String defaultValue)
extends Record

One Model Feature of a kind: pattern koncept in presentation form: the referenced component first, then each declared field, labeled 1-indexed (Field 1 is the first declared field). The referenced component is never numbered because it is not part of the fields array at either the schema or the instance level.

Constructor Summary

Constructors

Constructor	Description
ModelFeature(String label, String meaning, String purpose, String dataType, String example, String defaultValue)	Creates an instance of a ModelFeature record class.

Method Summary

Modifier and Type	Method	Description
String	dataType()	Returns the value of the dataType record component.
String	defaultValue()	Returns the value of the defaultValue record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	example()	Returns the value of the example record component.
final int	hashCode()	Returns a hash code value for this object.
String	label()	Returns the value of the label record component.
String	meaning()	Returns the value of the meaning record component.
String	purpose()	Returns the value of the purpose record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ModelFeature

public ModelFeature(String label,
 String meaning,
 String purpose,
 String dataType,
 String example,
 String defaultValue)

Creates an instance of a ModelFeature record class.

Parameters:

label - the value for the label record component

meaning - the value for the meaning record component

purpose - the value for the purpose record component

dataType - the value for the dataType record component

example - the value for the example record component

defaultValue - the value for the defaultValue record component

Method Details

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.

label

public String label()

Returns the value of the label record component.

Returns:

the value of the label record component

meaning

public String meaning()

Returns the value of the meaning record component.

Returns:

the value of the meaning record component

purpose

public String purpose()

Returns the value of the purpose record component.

Returns:

the value of the purpose record component

dataType

public String dataType()

Returns the value of the dataType record component.

Returns:

the value of the dataType record component

example

public String example()

Returns the value of the example record component.

Returns:

the value of the example record component

defaultValue

public String defaultValue()

Returns the value of the defaultValue record component.

Returns:

the value of the defaultValue record component