com.azalient.api.b.network
Interface ISequence

All Superinterfaces:

IRecord, RecordR, RecordRW, RecordW, SortableData

All Known Subinterfaces:

IService, ITrail

public interface ISequence
extends RecordRW

A sequence is the base interface for trails and services. It is comprised of a sequence of route branches or "twigs".

Field Summary

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

DELETED, KEY_SEP, KEY_SEP_CHAR

Method Summary

boolean	canJoinTo(ISequence that) Returns true if this sequence can join to that sequence
int	components() The number of components making up this sequence
ISequence	copy() Create a copy of this sequence
IXyz	endLocation() The location of the end of the last segment of this sequence, to centre the view when building or modifying the sequence
void	extend(int chosenExit, boolean multipleAdvance) Extend the sequence onto to the chosen exit, advancing multiple (links) if set, chosenExit index = 1..N
void	extendBack(int chosenEntry, boolean multipleAdvance) Extend the sequence to include the chosen entry, advancing multiple (links) if set, chosenEntry index = 1..N
ITwig[]	extensionBackSequence(int index) Return a sequence of links to display as an extension option, index = 0..N-1
String	extensionBackSequenceName(int index) Return the name of the entry numbered "index", where index = 0..N-1
int	extensionBackSequences() The number of possible entries to the start of the sequence, for extending this sequence backwards
ITwig[]	extensionSequence(int index) Return a sequence of links to display as an extension option, index = 0..N-1
String	extensionSequenceName(int index) Return the name of the exit numbered "index", where index = 0..N-1
int	extensionSequences() The number of possible exits from the end of this sequence.
String	info() Return an information description of this sequence, for display at the bottom of the GUI window
ISequence	join(String name, ISequence that) Returns a new sequence, with the given name, resulting from joining this sequence to that
void	prune1() Remove the first segment from the sequence
void	pruneN() Remove the last segment from the sequence
void	rename(String s) Rename this sequence to the given name
IXyz	startLocation() The location of the beginning first segment of this sequence, to centre the view when building or modifying the sequence
ITwig[]	twigs() An ordered array of routing branches or "twigs" that make up this sequence.

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

rename

void rename(String s)

Rename this sequence to the given name

copy

ISequence copy()

Create a copy of this sequence

components

int components()

The number of components making up this sequence

startLocation

IXyz startLocation()

The location of the beginning first segment of this sequence, to centre the view when building or modifying the sequence

endLocation

IXyz endLocation()

The location of the end of the last segment of this sequence, to centre the view when building or modifying the sequence

extensionSequences

int extensionSequences()

The number of possible exits from the end of this sequence. Each exit could be used to extend this sequence

extensionSequence

ITwig[] extensionSequence(int index)

Return a sequence of links to display as an extension option, index = 0..N-1

extensionSequenceName

String extensionSequenceName(int index)

Return the name of the exit numbered "index", where index = 0..N-1

extensionBackSequences

int extensionBackSequences()

The number of possible entries to the start of the sequence, for extending this sequence backwards

extensionBackSequence

ITwig[] extensionBackSequence(int index)

Return a sequence of links to display as an extension option, index = 0..N-1

extensionBackSequenceName

String extensionBackSequenceName(int index)

Return the name of the entry numbered "index", where index = 0..N-1

twigs

ITwig[] twigs()

An ordered array of routing branches or "twigs" that make up this sequence.

extend

void extend(int chosenExit,
            boolean multipleAdvance)

Extend the sequence onto to the chosen exit, advancing multiple (links) if set, chosenExit index = 1..N

extendBack

void extendBack(int chosenEntry,
                boolean multipleAdvance)

Extend the sequence to include the chosen entry, advancing multiple (links) if set, chosenEntry index = 1..N

prune1

void prune1()

Remove the first segment from the sequence

pruneN

void pruneN()

Remove the last segment from the sequence

canJoinTo

boolean canJoinTo(ISequence that)

Returns true if this sequence can join to that sequence

join

ISequence join(String name,
               ISequence that)

Returns a new sequence, with the given name, resulting from joining this sequence to that

info

String info()

Return an information description of this sequence, for display at the bottom of the GUI window