com.azalient.api.file
Interface StoreRecordRW

All Superinterfaces:
IRecord, RecordR, RecordRW, RecordW, SortableData
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, IMotorType, INetPoint, INode, IPassenger, IPastable, IPerson, IPersonTrip, IPersonType, IPhase, IPhaseCrossing, IPlace, IPlaceIndex, IPlan, IPluginInfo, IProfile, IReportingOption, IRestriction, IRouteClass, IRouteClassBehaviour, IScenario, ISector, 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
All Known Implementing Classes:
AbstractStoreRecordFixedName, AbstractStoreRecordIndirectName, AbstractStoreRecordRenamable, AbstractStoreRecordRenamableNumeric

public interface StoreRecordRW
extends RecordRW

An extension of the read-write record type, a store record has a reference to a store, and the optional ability to be renamed. As all objects in the store are referenced by their name through a hash table, the renaming process must also change the hash table in the store.


Field Summary
 
Fields inherited from interface com.azalient.api.a.tables.IRecord
DELETED, KEY_SEP, KEY_SEP_CHAR
 
Method Summary
 boolean canRename()
          Returns true if this record can be renamed.
 void rename(String s)
          Rename this record, if that is possible.
 IStore store()
          The store to which this record belongs.
 
Methods inherited from interface com.azalient.api.file.RecordR
extraSet, finished, isApplicable, isEditable, set
 
Methods inherited from interface com.azalient.api.a.tables.IRecord
name
 
Methods inherited from interface com.azalient.api.file.RecordW
extraCols, extraGet, extraGetB, extraGetD, extraGetI, extraGetS, extraGetT, get, isVolatile
 

Method Detail

store

IStore store()
The store to which this record belongs. This many be null in some cases.


rename

void rename(String s)
Rename this record, if that is possible. If it is not possible an error will be generated, so if you are not sure, check first using canRename()


canRename

boolean canRename()
Returns true if this record can be renamed. Renaming must update the hash table, as all records are indexed by their name. Some types of record have indirect names, based on associated objects, and cannot be renamed directly.