Interface RecordType

  • All Superinterfaces:
    Type

    @UML(identifier="RecordType",
         specification=ISO_19103)
    public interface RecordType
    extends Type
    The type definition of a record. A RecordType defines dynamically constructed data type. This interface has methods for data access, but no methods to dynamically add members. This approach ensures that once a RecordType is constructed, it is immutable.

    A RecordType is identified by a TypeName. It contains an arbitrary amount of member types. A RecordType may therefore contain another RecordType as a member.

    This class can be think as the equivalent of the Java Class class.

    Since:
    2.1
    Version:
    3.0
    See Also:
    Record, RecordSchema
    • Method Detail

      • getContainer

        RecordSchema getContainer()
        Returns the schema that contains this record type.
        Returns:
        The schema that contains this record type.
      • getMemberTypes

        @UML(identifier="memberTypes",
             obligation=MANDATORY,
             specification=ISO_19103)
        java.util.Map<MemberName,​Type> getMemberTypes()
        Returns the dictionary of all (name, type) pairs in this record type. If there are no attributes, this method returns the empty map. The dictionary shall be unmodifiable.

        The name space associated with a RecordType contains only members of this RecordType. There is no potential for conflict with sub-packages.

        This method can be think as the equivalent of the Java Class.getFields() method.

        Returns:
        The dictionary of all (name, type) pairs in this record type.
        See Also:
        Record.getAttributes()
      • getMembers

        java.util.Set<MemberName> getMembers()
        Returns the set of member names defined in this RecordType's dictionary. If there are no members, this method returns the empty set. This method is functionally equivalent to getMemberTypes().keySet().

        The name space associated with a RecordType contains only members of this RecordType. There is no potential for conflict with sub-packages.

        This method can be think as the equivalent of the Java Class.getFields() method.

        Returns:
        The set of attribute names defined in this RecordType's dictionary.
      • isInstance

        boolean isInstance​(Record record)
        Determines if the specified record is compatible with this record type. This method returns true if the specified record argument is non-null and the following condition holds:

        This method can be think as the equivalent of the Java Class.isInstance(Object) method.

        Parameters:
        record - The record to test for compatibility.
        Returns:
        true if the given record is compatible with this record type.