Interface RecordType

All Superinterfaces:

Type

All Known Implementing Classes:

Default­Record­Type

@UML(identifier="RecordType",
     specification=ISO_19103)
public interface RecordType
extends Type

The type definition of a record. A Record­Type 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 Record­Type is constructed, it is immutable.

A Record­Type is identified by a Type­Name. It contains an arbitrary amount of member types. A Record­Type may therefore contain another Record­Type as a member.

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

Since:

2.1

See Also:

• Record
• Record­Schema

Method Summary

Modifier and Type	Method	Description
Record­Schema	get­Container()	Returns the schema that contains this record type.
Set<Member­Name>	get­Members()	Returns the set of member names defined in this Record­Type's dictionary.
Map<Member­Name, Type>	get­Member­Types()	Returns the dictionary of all (name, type) pairs in this record type.
Type­Name	get­Type­Name()	Returns the name that identifies this record type.
boolean	is­Instance(Record record)	Determines if the specified record is compatible with this record type.
Type­Name	locate(Member­Name name)	Looks up the provided attribute name and returns the associated type name.

Method Details

getTypeName

@UML(identifier="typeName",
     obligation=MANDATORY,
     specification=ISO_19103)
TypeName getTypeName()

Returns the name that identifies this record type. If this Record­Type is contained in a record schema, then the record type name shall be a valid in the name space of the record schema:

get­Container().get­Schema­Name().scope()

This method can be think as the equivalent of the Java Class.get­Name() method.

Specified by:

get­Type­Name in interface Type

Returns:

The name that identifies this record type.

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)
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 Record­Type contains only members of this Record­Type. There is no potential for conflict with sub-packages.

This method can be think as the equivalent of the Java Class.get­Fields() method.

Returns:

The dictionary of all (name, type) pairs in this record type.

See Also:

• Record.get­Attributes()

getMembers

Set<MemberName> getMembers()

Returns the set of member names defined in this Record­Type's dictionary. If there are no members, this method returns the empty set. This method is functionally equivalent to get­Member­Types().key­Set().

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

This method can be think as the equivalent of the Java Class.get­Fields() method.

Returns:

The set of attribute names defined in this Record­Type's dictionary.

locate

@UML(identifier="locate",
     obligation=MANDATORY,
     specification=ISO_19103)
TypeName locate(MemberName name)

Looks up the provided attribute name and returns the associated type name. If the attribute name is not defined in this record type, then this method returns null. This method is functionally equivalent to get­Member­Types().get(name).get­Type­Name().

This method can be think as the equivalent of the Java Class.get­Field(String) method.

Parameters:

name - The name of the attribute we are looking for.

Returns:

The type of of attribute of the given name, or null.

See Also:

• Record.locate(Member­Name)

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:

• get­Members().contains­All(record.get­Attributes().key­Set())
• Any other implementation-specific conditions.

This method can be think as the equivalent of the Java Class.is­Instance(Object) method.

Parameters:

record - The record to test for compatibility.

Returns:

true if the given record is compatible with this record type.