Module dev.metaschema.databind
Package dev.metaschema.databind.model.metaschema.binding

Class FieldReference

java.lang.Object
dev.metaschema.databind.model.metaschema.binding.FieldReference
All Implemented Interfaces:
IBoundObject
@MetaschemaAssembly(formalName="Field Reference", name="field-reference", moduleClass=MetaschemaModelModule.class) public class FieldReference extends Object implements IBoundObject
Field Reference.

  • Constructor Details

    • FieldReference

      public FieldReference()
      Constructs a new dev.metaschema.databind.model.metaschema.binding.FieldReference instance with no metadata.

    • FieldReference

      public FieldReference(IMetaschemaData data)
      Constructs a new dev.metaschema.databind.model.metaschema.binding.FieldReference instance with the specified metadata.
      Parameters:
      data - the metaschema data, or null if none

  • Method Details

    • getMetaschemaData

      public IMetaschemaData getMetaschemaData()
      Description copied from interface: IBoundObject
      Get additional Metaschema-related information for the object (i.e., resource location).
      Specified by:
      getMetaschemaData in interface IBoundObject
      Returns:
      the Metaschema-related information

    • getRef

      @NonNull public String getRef()
      Get the global Field Reference.
      Returns:
      the ref value

    • setRef

      public void setRef(@NonNull String value)
      Set the global Field Reference.
      Parameters:
      value - the ref value to set

    • getIndex

      @Nullable public BigInteger getIndex()
      Get the field Reference Binary Name.
      Returns:
      the index value, or null if not set

    • setIndex

      public void setIndex(@Nullable BigInteger value)
      Set the field Reference Binary Name.
      Parameters:
      value - the index value to set, or null to clear

    • getDeprecated

      @Nullable public String getDeprecated()
      Get the deprecated Version.
      Returns:
      the deprecated value, or null if not set

    • setDeprecated

      public void setDeprecated(@Nullable String value)
      Set the deprecated Version.
      Parameters:
      value - the deprecated value to set, or null to clear

    • getDefault

      @Nullable public String getDefault()
      Get the default Field Value.
      Returns:
      the default value, or null if not set

    • setDefault

      public void setDefault(@Nullable String value)
      Set the default Field Value.
      Parameters:
      value - the default value to set, or null to clear

    • getMinOccurs

      @Nullable public BigInteger getMinOccurs()
      Get the minimum Occurrence.
      Returns:
      the min-occurs value, or null if not set

    • setMinOccurs

      public void setMinOccurs(@Nullable BigInteger value)
      Set the minimum Occurrence.
      Parameters:
      value - the min-occurs value to set, or null to clear

    • getMaxOccurs

      @Nullable public String getMaxOccurs()
      Get the maximum Occurrence.
      Returns:
      the max-occurs value, or null if not set

    • setMaxOccurs

      public void setMaxOccurs(@Nullable String value)
      Set the maximum Occurrence.
      Parameters:
      value - the max-occurs value to set, or null to clear

    • getInXml

      @Nullable public String getInXml()
      Get the field In XML.
      Returns:
      the in-xml value, or null if not set

    • setInXml

      public void setInXml(@Nullable String value)
      Set the field In XML.
      Parameters:
      value - the in-xml value to set, or null to clear

    • getFormalName

      @Nullable public String getFormalName()
      Get the formal Name.

      A formal name for the data construct, to be presented in documentation.

      Returns:
      the formal-name value, or null if not set

    • setFormalName

      public void setFormalName(@Nullable String value)
      Set the formal Name.

      A formal name for the data construct, to be presented in documentation.

      Parameters:
      value - the formal-name value to set, or null to clear

    • getDescription

      @Nullable public MarkupLine getDescription()
      Get the description.

      A short description of the data construct's purpose, describing the constructs semantics.

      Returns:
      the description value, or null if not set

    • setDescription

      public void setDescription(@Nullable MarkupLine value)
      Set the description.

      A short description of the data construct's purpose, describing the constructs semantics.

      Parameters:
      value - the description value to set, or null to clear

    • getProps

      @NonNull public List<Property> getProps()
      Get the property.
      Returns:
      the prop value

    • setProps

      public void setProps(@NonNull List<Property> value)
      Set the property.
      Parameters:
      value - the prop value to set

    • addProp

      public boolean addProp(Property item)
      Add a new Property item to the underlying collection.
      Parameters:
      item - the item to add
      Returns:
      true

    • removeProp

      public boolean removeProp(Property item)
      Remove the first matching Property item from the underlying collection.
      Parameters:
      item - the item to remove
      Returns:
      true if the item was removed or false otherwise

    • getUseName

      @Nullable public UseName getUseName()
      Get the use Name.

      Allows the name of the definition to be overridden.

      Returns:
      the use-name value, or null if not set

    • setUseName

      public void setUseName(@Nullable UseName value)
      Set the use Name.

      Allows the name of the definition to be overridden.

      Parameters:
      value - the use-name value to set, or null to clear

    • getGroupAs

      @Nullable public GroupingAs getGroupAs()
      Get the group As.
      Returns:
      the group-as value, or null if not set

    • setGroupAs

      public void setGroupAs(@Nullable GroupingAs value)
      Set the group As.
      Parameters:
      value - the group-as value to set, or null to clear

    • getRemarks

      @Nullable public Remarks getRemarks()
      Get the remarks.

      Any explanatory or helpful information to be provided about the remarks parent.

      Returns:
      the remarks value, or null if not set

    • setRemarks

      public void setRemarks(@Nullable Remarks value)
      Set the remarks.

      Any explanatory or helpful information to be provided about the remarks parent.

      Parameters:
      value - the remarks value to set, or null to clear

    • toString

      public String toString()
      Overrides:
      toString in class Object