gzz
Interface Space

gzz.Cell gzz.Dim gzz.Space gzz.CellTexter gzz.VStreamCellTexter gzz.JavaObjector gzz.Obs gzz.ObsTrigger ../../Gzz_CoreAPIs.gen.html#core core_small gzz.Space gzz.impl.AbstractSpace gzz.CellTexter gzz.VStreamCellTexter gzz.impl.SimpleVStreamTexter gzz.impl.ModularSpace gzz.ObsTrigger gzz.impl.SimpleObsTrigger gzz.IdentityManager gzz.impl.DummyIdentityManager gzz.CellManager gzz.impl.AbstractCellManager gzz.impl.PlainCellManager gzz.DimManager gzz.impl.AbstractDimManager SimpleDim.Manager gzz.diff.DeltaSpace gzz.impl.ModularDeltaSpace gzz.diff.DeltaDimManager gzz.diff.DeltaCellTexter gzz.impl.AbstractDeltaDimManager gzz.impl.SimpleDeltaVStreamTexter ../../Gzz_Backend.gen.html#modularspace modularspace_small
All Known Subinterfaces:
DeltaSpace, SliceSpace
All Known Implementing Classes:
AbstractSpace, ModularDeltaSpace

public interface Space

A ZZ space - a set of cells and connections.


Field Summary
static java.lang.String rcsid
           
 
Method Summary
 void delete(Cell c)
          Delete a given cell.
 boolean exists(java.lang.String id)
          Whether a cell with the given ID exists in this space.
 Cell getCell(java.lang.String id)
          Get a cell by its ID.
 CellTexter getCellTexter()
           
 Dim getCloneDim()
          Get the clone dimension of this space.
 Dim getDim(Cell name)
          Get a dimension by cell.
 Dim getDim(java.lang.String s)
          Get a dimension by cell id.
 java.util.Set getDims()
          Get the set of all dimensions in this space.
 Cell getHomeCell()
          Get the home cell of this space.
 Cell getIdentity(Cell c)
          Get the canonical cell representing a given cell's global identity.
 Cell getIdentity(java.lang.String s)
          Get the cell representing a given global identity.
 JavaObjector getJavaObjector()
           
 Mediaserver getMediaserver()
          Deprecated. Will be abstracted to an object that produces spans on request.
 Cell getMSBlockCell(java.lang.String msid, Cell cell)
          Get the cell representing the given mediaserver block in the same slice as cell.
 ObsTrigger getObsTrigger()
           
 Cell N()
          Create a new cell connected to the home slice.
 Cell N(Cell inSlice)
          Create a new cell in the same slice as the given cell.
 Cell N(Cell inSlice, Cell dim, int dir, Obs o)
           
 Cell N(Cell inSlice, Dim dim, int dir, Obs o)
          Create a new cell in the same slice as the given cell, and connect it in the direction given.
 Cell zzclone(Cell cellToClone, Cell cloneInSlice)
          Clone a cell.
 

Field Detail

rcsid

public static final java.lang.String rcsid
See Also:
Constant Field Values
Method Detail

getHomeCell

public Cell getHomeCell()
Get the home cell of this space. The home cell is where everything begins.


getCell

public Cell getCell(java.lang.String id)
Get a cell by its ID.


getDim

public Dim getDim(Cell name)
Get a dimension by cell. The same Dim object should be returned when this is called with Cells that are clones of each other.


getDims

public java.util.Set getDims()
Get the set of all dimensions in this space.

Returns:
A Set, containing Dim objects for the dimensions in this space.

getDim

public Dim getDim(java.lang.String s)
Get a dimension by cell id.


getIdentity

public Cell getIdentity(java.lang.String s)
Get the cell representing a given global identity.


getIdentity

public Cell getIdentity(Cell c)
Get the canonical cell representing a given cell's global identity.


getCloneDim

public Dim getCloneDim()
Get the clone dimension of this space.


zzclone

public Cell zzclone(Cell cellToClone,
                    Cell cloneInSlice)
Clone a cell.

Parameters:
cellToClone - The cell to clone
cloneInSlice - A cell of the slice the clone should be in. May be null.

N

public Cell N()
Create a new cell connected to the home slice. Defined to be equivalent to N(getHomeCell()).


N

public Cell N(Cell inSlice)
Create a new cell in the same slice as the given cell.


N

public Cell N(Cell inSlice,
              Dim dim,
              int dir,
              Obs o)
Create a new cell in the same slice as the given cell, and connect it in the direction given.

Parameters:
o - The observer to call when s(inSlice, dim, dir) would not return the cell created by this call any more.

N

public Cell N(Cell inSlice,
              Cell dim,
              int dir,
              Obs o)

delete

public void delete(Cell c)
Delete a given cell.


exists

public boolean exists(java.lang.String id)
Whether a cell with the given ID exists in this space.


getMediaserver

public Mediaserver getMediaserver()
Deprecated. Will be abstracted to an object that produces spans on request.

Get the instance of mediaserver associated with this space. May return null.


getMSBlockCell

public Cell getMSBlockCell(java.lang.String msid,
                           Cell cell)
Get the cell representing the given mediaserver block in the same slice as cell. May return null.


getObsTrigger

public ObsTrigger getObsTrigger()

getCellTexter

public CellTexter getCellTexter()

getJavaObjector

public JavaObjector getJavaObjector()