Class dnx.lr.ConstNodeDefinition 
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class dnx.lr.ConstNodeDefinition 

java.lang.Object
   |
   +----dnx.lr.ConstNodeDefinition
public class ConstNodeDefinition
extends Object
This class is like a "read-only" NodeDefinition class. When you ask a node for its definition, you get one of these rather than a NodeDefinition. We use it so that individual node classes can't mess with any node definitions; otherwise random (network) code could potentially mess up the definitions, which would mess up everything further until the program was restarted. We don't do such encapsulation with fields because a mess-up there is not so horrible.

Constructor Index

o ConstNodeDefinition(NodeDefinition)

Method Index

o countEmbeddedChildCarryingFields()
Return the number of embedded child-carrying fields in the NodeDefinition.
o countEmbeddedFields()
Return the number of embedded fields in the NodeDefinition.
o countEventIns()
Return the number of EventIns in the NodeDefinition.
o countEventOuts()
Return the number of EventOuts in the NodeDefinition.
o countExposedChildCarryingFields()
Return the number of exposed child-carrying fields (i.e.
o countExposedFields()
Return the number of exposed fields in the NodeDefinition.
o countNonEmbeddedChildCarryingFields()
Return the number of child-carrying fields (i.e.
o countNonEmbeddedFields()
Return the number of fields in the NodeDefinition, not including any embedded fields.
o countTotalChildCarryingFields()
Return the total number of child-carrying fields in the NodeDefinition, including any embedded fields.
o countTotalFields()
Return the total number of fields in the NodeDefinition, including any embedded fields.
o fieldIndexToFieldInstanceIndex(int)
Convert field index INDEX (which should be the index of a child- carrying field) into a field instance index.
o fieldInstanceIndexToFieldIndex(int)
Convert field instance index into a field index.
o getEmbeddedFieldIndex(int)
Return the field index of the nth embedded field, numbering from 0.
o getEventInIndex(String)
Get the index of a named EventIn from its name.
o getEventInName(int)
Get the name of an EventIn from its index.
o getEventInType(int)
Returns the type of EventIn from its index.
o getEventInType(String)
Returns the type of EventIn from its name.
o getEventOutIndex(String)
Get the index of a named EventOut.
o getEventOutName(int)
Get the name of an EventOut from its index.
o getEventOutType(int)
Returns the type of EventOut from its index.
o getEventOutType(String)
Returns the type of EventOut from its name.
o getFieldDefault(int)
Return the field default value/type given its index.
o getFieldDefault(String)
Return the field default value/type given its name.
o getFieldIndex(String)
Look up a field index given its name.
o getFieldName(int)
Look up a field name given its index.
o getInterfaceType(String)
Return whether a given name refers to a field, exposedField, eventIn, or eventOut.
o isFieldExposed(int)
Return true if a field is exposed, false if it isn't.

Constructors

o ConstNodeDefinition 
  public ConstNodeDefinition(NodeDefinition blunk)

Methods

o getInterfaceType 
  public int getInterfaceType(String name)
Return whether a given name refers to a field, exposedField, eventIn, or eventOut. Automatically-declared eventIns and eventOuts in exposedFields are correctly recognized. The result will be one of EXPOSED_FIELD, FIELD, EVENT_IN, EVENT_OUT, or UNKNONW.
o getFieldName 
  public String getFieldName(int index)
Look up a field name given its index.
o getFieldIndex 
  public int getFieldIndex(String name)
Look up a field index given its name.
o getFieldDefault 
  public final Field getFieldDefault(int index)
Return the field default value/type given its index.
o getFieldDefault 
  public final Field getFieldDefault(String fieldName)
Return the field default value/type given its name.
o isFieldExposed 
  public final boolean isFieldExposed(int index)
Return true if a field is exposed, false if it isn't.
o getEventInName 
  public String getEventInName(int index)
Get the name of an EventIn from its index. If the index refers to an invalid EventIn, null is returned.
o getEventInIndex 
  public int getEventInIndex(String name)
Get the index of a named EventIn from its name. If there is no EventIn with the specified name, -1 is returned.
o getEventInType 
  public final Class getEventInType(int index)
Returns the type of EventIn from its index. If the index refers to an invalid EventIn, null is returned.
o getEventInType 
  public final Class getEventInType(String eventName)
Returns the type of EventIn from its name. If the name refers to an invalid EventIn, null is returned.
o getEventOutName 
  public String getEventOutName(int index)
Get the name of an EventOut from its index. If the index refers to an invalid EventOut, null is returned.
o getEventOutIndex 
  public int getEventOutIndex(String name)
Get the index of a named EventOut. If there is no EventOut with the specified name, -1 is returned.
o getEventOutType 
  public final Class getEventOutType(int index)
Returns the type of EventOut from its index. If the index refers to an invalid EventOut, null is returned.
o getEventOutType 
  public final Class getEventOutType(String eventName)
Returns the type of EventOut from its name. If the name refers to an invalid EventOut, null is returned.
o getEmbeddedFieldIndex 
  public int getEmbeddedFieldIndex(int n)
Return the field index of the nth embedded field, numbering from 0.
o fieldIndexToFieldInstanceIndex 
  public int fieldIndexToFieldInstanceIndex(int index)
Convert field index INDEX (which should be the index of a child- carrying field) into a field instance index. Field instance indices are used to access the equivalent field instances out of a node instance.
o fieldInstanceIndexToFieldIndex 
  public int fieldInstanceIndexToFieldIndex(int index)
Convert field instance index into a field index. Field instance indices are used to access the equivalent field instances out of a node instance.
o countNonEmbeddedFields 
  public final int countNonEmbeddedFields()
Return the number of fields in the NodeDefinition, not including any embedded fields. (Embedded fields are those fields used internally to hold embedded nodes, such as in an InlineNode.)
o countEmbeddedFields 
  public final int countEmbeddedFields()
Return the number of embedded fields in the NodeDefinition. (Embedded fields are those fields used internally to hold embedded nodes, such as in an InlineNode.)
o countTotalFields 
  public final int countTotalFields()
Return the total number of fields in the NodeDefinition, including any embedded fields. (Embedded fields are those fields used internally to hold embedded nodes, such as in an InlineNode.)
o countExposedFields 
  public final int countExposedFields()
Return the number of exposed fields in the NodeDefinition. (Embedded fields can never be exposed fields.)
o countNonEmbeddedChildCarryingFields 
  public final int countNonEmbeddedChildCarryingFields()
Return the number of child-carrying fields (i.e. MFNodes and SFNodes) in the NodeDefinition, not including any embedded fields. (Embedded fields are those fields used internally to hold embedded nodes, such as in an InlineNode.)
o countEmbeddedChildCarryingFields 
  public final int countEmbeddedChildCarryingFields()
Return the number of embedded child-carrying fields in the NodeDefinition. (Embedded fields are those fields used internally to hold embedded nodes, such as in an InlineNode.)
o countTotalChildCarryingFields 
  public final int countTotalChildCarryingFields()
Return the total number of child-carrying fields in the NodeDefinition, including any embedded fields. (Embedded fields are those fields used internally to hold embedded nodes, such as in an InlineNode.)
o countExposedChildCarryingFields 
  public final int countExposedChildCarryingFields()
Return the number of exposed child-carrying fields (i.e. MFNodes and SFNodes) in the NodeDefinition. (Embedded fields can never be exposed fields.)
o countEventIns 
  public final int countEventIns()
Return the number of EventIns in the NodeDefinition. This includes those implicitly declared as part of an exposedField.
o countEventOuts 
  public final int countEventOuts()
Return the number of EventOuts in the NodeDefinition. This includes those implicitly declared as part of an exposedField. 
All Packages  Class Hierarchy  This Package  Previous  Next  Index