com.azalient.api.file
Interface RecordR

All Superinterfaces:

IRecord

All Known Subinterfaces:

IAgent, IArea, IAspect, IAttached, IBehaviour, ICentre, IChannel, IColour, IController, ICourse, ICrossing, ICrossingTime, IDiscreteDistribution, IDistribution, IDistributionBar, IDivision, IDwell, IEngine, IEngineRecord, IFeature, IFixture, IFleet, IGroup, IIncident, IIntersection, ILabel, ILane, ILink, ILoop, ILoopMultiple, IMatrixDescription, IMob, IMotor, IMotorCalibration, IMotorFollowing, IMotorType, INetPoint, INode, IPassenger, IPastable, IPedestrianCalibration, IPerson, IPersonTrip, IPersonType, IPhase, IPhaseCrossing, IPlace, IPlaceIndex, IPlan, IPluginInfo, IProfile, IReportingOption, IRestriction, IRouteClass, IRouteClassBehaviour, IScenario, ISector, ISequence, IService, IShape, ISign, ISignalDisplay, ISignalRule, ISpeedControl, ISplit, IStand, IStream, ISymbol, ITag, ITerm, ITextSize, ITimedEvent, ITrail, ITransport, ITransportTrip, ITransportType, ITrip, ITurn, IType, ITypeSet, IVehicle, IVehicleTrip, IVehicleType, IView, IVolume, IWalkway, IZone, RecordRW, StoreRecordRW

All Known Implementing Classes:

AbstractRecordR, AbstractRecordRW, AbstractStoreRecordFixedName, AbstractStoreRecordIndirectName, AbstractStoreRecordRenamable, AbstractStoreRecordRenamableNumeric

public interface RecordR
extends IRecord

On reading a table of data, the table reader calls TableR.row() and gets a handle to a RecordR. Normally, the record is created by that call, although it might already exist. Then the reader fills in each field of the record, one at a time by calling set().

Field Summary

Fields inherited from interface com.azalient.api.a.tables.IRecord

DELETED, KEY_SEP, KEY_SEP_CHAR

Method Summary

void	extraSet(Object columnKey, Object data) The (API) user can call this to store additional information in any record using "Extra" fields.
void	finished(TableR table) The parser calls this when all cells in a row have been read.
boolean	isApplicable(Object col) Return false to completely blank out the cell in the editor (value is not shown)
boolean	isEditable(Object col) Return false to grey out this field in the editor window (value is still shown)
void	set(Object columnKey, Object data) The file reader calls this on a record, when it is read.

Methods inherited from interface com.azalient.api.a.tables.IRecord

name

Method Detail

set

void set(Object columnKey,
         Object data)

The file reader calls this on a record, when it is read.

If the field is a multiple type (by convention the column name ends with '*') then this may be called several times
After the last cell in a row has been read, then the reader calls finished(TableR table)

Parameters:

columnKey - The key (name) of the field (column in the table), normally of type String

data - an object having one of the following types:

• String
• Double
• Integer
• Boolean
• UTime

finished

void finished(TableR table)

The parser calls this when all cells in a row have been read. Some records may have many fields and have their fields spread over more than one table. This might also happen if separate tables are used for logical separation of fields of different types. In this case, where the same class is providing the set() functions for multiple tables, that class needs to know which table has been finished, hence the parameter.

extraSet

void extraSet(Object columnKey,
              Object data)

The (API) user can call this to store additional information in any record using "Extra" fields. There is no limit to the number of Extra fields, the only constraint is that the field name must be unique.

Parameters:

columnKey - The key (name) of the field (column in the table), normally of type String

data - an object having one of the following types:

• String
• Double
• Integer
• Boolean
• UTime

isEditable

boolean isEditable(Object col)

Return false to grey out this field in the editor window (value is still shown)

isApplicable

boolean isApplicable(Object col)

Return false to completely blank out the cell in the editor (value is not shown)