net.sourceforge.nite.meta
Interface NLayer

All Known Implementing Classes:
NiteLayer

public interface NLayer

Layers describe the permissible content models of the hierarchies in the NOM. We assume a content model of (child1|child2|...|childn)* A stricter model may be used in other parts of the system.

Author:
jonathan

Field Summary
static int EXTERNAL_POINTER_LAYER
           
static int FEATURAL_LAYER
           
static int STRUCTURAL_LAYER
           
static int TIMED_LAYER
           
 
Method Summary
 void addProgramArgument(java.lang.String parameter, java.lang.String value)
          the arguments to pass to the program associated with the external pointer for this layer: this value will only ever be non-null when the layer type is EXTERNAL_POINTER_LAYER.
 NLayer getChildLayer()
          Get the layer below this in the hierarchy.
 java.lang.String getChildLayerName()
          get the name of the layer from which this layer draws children
 java.lang.Object getContainer()
          Returns the container to which this layer belongs.
 java.util.List getContentElements()
          get the list of elements valid in this layer - returns a List of NElements
 java.lang.String getContentType()
          the content type of this external layer: this value will only ever be non-null when the layer type is EXTERNAL_POINTER_LAYER.
 int getLayerType()
          returns one of TIMED_LAYER, STRUCTURAL_LAYER, FEATURAL_LAYER or EXTERNAL_POINTER_LAYER
 java.lang.String getName()
          returns the name of the layer.
 NLayer getParentLayerInCoding(java.lang.Object container)
          Find the parent layer in the given coding
 java.util.List getParentLayers()
          get the parent(s) of this layer - returns a List of NLayers
 java.lang.String getProgram()
          the program associated with the external pointer for this layer: this value will only ever be non-null when the layer type is EXTERNAL_POINTER_LAYER.
 java.util.List getProgramArguments()
          the arguments to pass to the program associated with the external pointer for this layer: this value will only ever be non-null when the layer type is EXTERNAL_POINTER_LAYER.
 boolean getRecursive()
          Whether the sub-layer is pointed to recursively
 boolean inheritsTime()
          return true if this layer can inherit time from lower layers.
 boolean isTopLayerInCoding()
           
 

Field Detail

FEATURAL_LAYER

static final int FEATURAL_LAYER
See Also:
Constant Field Values

STRUCTURAL_LAYER

static final int STRUCTURAL_LAYER
See Also:
Constant Field Values

TIMED_LAYER

static final int TIMED_LAYER
See Also:
Constant Field Values

EXTERNAL_POINTER_LAYER

static final int EXTERNAL_POINTER_LAYER
See Also:
Constant Field Values
Method Detail

getName

java.lang.String getName()
returns the name of the layer.


getLayerType

int getLayerType()
returns one of TIMED_LAYER, STRUCTURAL_LAYER, FEATURAL_LAYER or EXTERNAL_POINTER_LAYER


getContainer

java.lang.Object getContainer()
Returns the container to which this layer belongs. Containers are one of NCoding, NOntology or NObjectSet


getParentLayers

java.util.List getParentLayers()
get the parent(s) of this layer - returns a List of NLayers


getParentLayerInCoding

NLayer getParentLayerInCoding(java.lang.Object container)
Find the parent layer in the given coding


getChildLayer

NLayer getChildLayer()
Get the layer below this in the hierarchy. Note that this child may not be in the same NCoding.


getContentElements

java.util.List getContentElements()
get the list of elements valid in this layer - returns a List of NElements


getRecursive

boolean getRecursive()
Whether the sub-layer is pointed to recursively


isTopLayerInCoding

boolean isTopLayerInCoding()

inheritsTime

boolean inheritsTime()
return true if this layer can inherit time from lower layers. This allows us to have structural layers that have temporally overlapping children


getContentType

java.lang.String getContentType()
the content type of this external layer: this value will only ever be non-null when the layer type is EXTERNAL_POINTER_LAYER. This can be used instead of getProgram.


getProgram

java.lang.String getProgram()
the program associated with the external pointer for this layer: this value will only ever be non-null when the layer type is EXTERNAL_POINTER_LAYER.


getProgramArguments

java.util.List getProgramArguments()
the arguments to pass to the program associated with the external pointer for this layer: this value will only ever be non-null when the layer type is EXTERNAL_POINTER_LAYER.


addProgramArgument

void addProgramArgument(java.lang.String parameter,
                        java.lang.String value)
the arguments to pass to the program associated with the external pointer for this layer: this value will only ever be non-null when the layer type is EXTERNAL_POINTER_LAYER.


getChildLayerName

java.lang.String getChildLayerName()
get the name of the layer from which this layer draws children