parsedtree
Class UnitDefinition

java.lang.Object
  parsedtree.BaseParticipantDefinition
      parsedtree.UnitDefinition

public class UnitDefinition

extends BaseParticipantDefinition

Represents a unit, containing the details of the unit such as the list of people who form the unit and the type of the unit.

UnitDefinition objects do not contain any information about when and where the objects are formed or disbanded. This information is contained in the FormUnit and DisbandUnit objects. The FormUnit and DisbandUnit objects reference the UnitDefinition object.

Version:

1.0

Author:

Nigel R. Westbury

See Also:

FormUnit, DisbandUnit

Field Summary

int	chirality Indicates whether the unit is a 'left handed' or a 'right handed' unit.
ParticipatingParticipants	participatingParticipants The participants in the unit.
UnitTypeDefinition	unitType The object containing the details for the type of unit.
(package private) java.lang.String	unitTypeName Temporary holder for the name of the unit type.

Fields inherited from class parsedtree.BaseParticipantDefinition

name

Constructor Summary

UnitDefinition()

Methods inherited from class parsedtree.BaseParticipantDefinition

getName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

unitTypeName

java.lang.String unitTypeName

Temporary holder for the name of the unit type. The XMLParser class stores the name of the unit type here when the form_unit element is processed. It then uses this name in a later pass to resolve this name to a pointer to the a UnitTypeDefinition object.

unitType

public UnitTypeDefinition unitType

The object containing the details for the type of unit.

participatingParticipants

public ParticipatingParticipants participatingParticipants

The participants in the unit.

chirality

public int chirality

Indicates whether the unit is a 'left handed' or a 'right handed' unit. Some units can be formed in both left handed and right handed versions. The 'handedness' of a unit is known as the chirality.

• 0 = No 'left' or 'right' chirality was specified when the unit was formed. This is valid if and only if no chirality was specified in the unit type definition.
• -1 = The unit is to be formed as a left handed unit. If the unit type definition indicates that a right handed version of the unit is being defined then that unit definition can be used but it will be reflected.
• 1 = The unit is to be formed as a right handed unit. If the unit type definition indicates that a left handed version of the unit is being defined then that unit definition can be used but it will be reflected.

Constructor Detail

UnitDefinition

public UnitDefinition()