LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.info
Class LyInfoTokens

java.lang.Object
  extended by leon.info.LyInfoTokens

public final class LyInfoTokens
extends java.lang.Object

This class is a utility class used to support static attributes and methods related to data description parser. It gives the list of all known XML tags and their correlated attributes, and also the lists of supported objectInfo tags. It offers utility methods to convert string tokens into known objectInfo types.

See Also:
LyInfoParser

Field Summary
static java.lang.String __VERSION
           
static java.lang.String[] actionMarks
          List of supported action marks.
static java.lang.String[] classInfoMarks
          List of supported classInfo marks.
static java.lang.String[] fieldInfoMarks
          List of supported fieldInfo marks.
static int LAST_EXTRA_ACTION_MARKS
          Indexes of last extra marks.
static int LAST_EXTRA_CLASS_MARKS
           
static int LAST_EXTRA_FIELD_MARKS
           
 
Constructor Summary
LyInfoTokens()
           
 
Method Summary
static void clearExtraMarksIndexes()
          Clears extra marks indexes.
static java.lang.String[] getActionMarks()
          Gets the list of supported Action marks, these are the marks that defines a generic behavior for the actions.
static LyChartInfo.GraphType getChartInfoGraphType(java.lang.String type)
          Utility method to get graph type from a token string.
static LyChartInfo.ValType getChartInfoValType(java.lang.String type)
          Utility method to get chart value type from a token string.
static LyInfoCache.CachePolicy getClassInfoCachePolicy(java.lang.String type)
          Utility method to get class cache policy.
static java.lang.String[] getClassInfoMarks()
          Gets the list of supported classInfo marks, these are the marks that defines a generic behavior for the class infos.
static java.lang.String[] getExtraActionMarks()
          Gets the list of extra Action marks.
static java.lang.String[] getExtraClassInfoMarks()
          Gets the list of extra classInfo marks.
static java.lang.String[] getExtraFieldInfoMarks()
          Gets the list of extra fieldInfo marks.
static java.lang.String[] getFieldInfoMarks()
          Gets the list of supported fieldInfo marks, these are the marks that defines a generic behavior for the field infos.
static int getMarkIndex(LyBitSet.Type type, java.lang.String markName, boolean add)
          Finds a bit corresponding to a project specific mark to set within a bitset.
static java.lang.String getMarkName(LyBitSet.Type type, int markIndex)
          Finds the mark name for a defined mark (standard or specific).
static void registerExtraMarksIndexes()
          Registers extra marks indexes.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

__VERSION

public static final java.lang.String __VERSION
See Also:
Constant Field Values

actionMarks

public static java.lang.String[] actionMarks
List of supported action marks.


classInfoMarks

public static java.lang.String[] classInfoMarks
List of supported classInfo marks.


fieldInfoMarks

public static java.lang.String[] fieldInfoMarks
List of supported fieldInfo marks.


LAST_EXTRA_ACTION_MARKS

public static int LAST_EXTRA_ACTION_MARKS
Indexes of last extra marks.


LAST_EXTRA_CLASS_MARKS

public static int LAST_EXTRA_CLASS_MARKS

LAST_EXTRA_FIELD_MARKS

public static int LAST_EXTRA_FIELD_MARKS
Constructor Detail

LyInfoTokens

public LyInfoTokens()
Method Detail

getClassInfoCachePolicy

public static LyInfoCache.CachePolicy getClassInfoCachePolicy(java.lang.String type)
Utility method to get class cache policy.

Parameters:
type - The token.
Returns:
The corresponding class cache policy if it exists.
Throws:
java.lang.IllegalArgumentException - if the given token doesn't correspond to any known class cache policy.

getChartInfoGraphType

public static LyChartInfo.GraphType getChartInfoGraphType(java.lang.String type)
Utility method to get graph type from a token string.

Parameters:
type - The token.
Returns:
The corresponding chart type if it exists.
Throws:
java.lang.IllegalArgumentException - If the given token doesn't correspond to any known chart type.

getChartInfoValType

public static LyChartInfo.ValType getChartInfoValType(java.lang.String type)
Utility method to get chart value type from a token string.

Parameters:
type - The token.
Returns:
The corresponding values type for a chart if it exists (like REAL, COUNT_INTERVAL, etc.).
Throws:
java.lang.IllegalArgumentException - If the given token doesn't correspond to any known values grouping for chart.

getMarkIndex

public static int getMarkIndex(LyBitSet.Type type,
                               java.lang.String markName,
                               boolean add)
Finds a bit corresponding to a project specific mark to set within a bitset. For each type of specific mark, the first time this method is called with a specific mark, a position is given for it and is returned for further calls.

Parameters:
type - Type mark (actions : A_MARKS, classes : C_MARKS, fields : F_MARKS).
markName - Name of the project specific mark.
add - Indicates if the mark must be added if not found.
Returns:
The position corresponding to the specific mark.
Throws:
java.lang.IllegalArgumentException - If the type doesn't correspond to any supported marks type.

getMarkName

public static java.lang.String getMarkName(LyBitSet.Type type,
                                           int markIndex)
Finds the mark name for a defined mark (standard or specific).

Parameters:
type - Type mark (actions : A_MARKS, classes : C_MARKS, fields : F_MARKS).
markIndex - Bit corresponding to a specific mark of the project.
Returns:
The position corresponding to the specific mark.
Throws:
java.lang.IllegalArgumentException - If the type doesn't correspond to any supported marks type.

getActionMarks

public static java.lang.String[] getActionMarks()
Gets the list of supported Action marks, these are the marks that defines a generic behavior for the actions.

Returns:
Table of supported action marks names.

getExtraActionMarks

public static java.lang.String[] getExtraActionMarks()
Gets the list of extra Action marks.

Returns:
Table of extra action marks names.

getClassInfoMarks

public static java.lang.String[] getClassInfoMarks()
Gets the list of supported classInfo marks, these are the marks that defines a generic behavior for the class infos.

Returns:
Table of supported class info marks names.

getExtraClassInfoMarks

public static java.lang.String[] getExtraClassInfoMarks()
Gets the list of extra classInfo marks.

Returns:
Table of extra classInfo marks names.

getFieldInfoMarks

public static java.lang.String[] getFieldInfoMarks()
Gets the list of supported fieldInfo marks, these are the marks that defines a generic behavior for the field infos.

Returns:
Table of supported field info marks names.

getExtraFieldInfoMarks

public static java.lang.String[] getExtraFieldInfoMarks()
Gets the list of extra fieldInfo marks.

Returns:
Table of extra fieldInfo marks names.

registerExtraMarksIndexes

public static void registerExtraMarksIndexes()
Registers extra marks indexes.


clearExtraMarksIndexes

public static void clearExtraMarksIndexes()
Clears extra marks indexes.


(c) January 2013 - W4 S.A.

Website: W4 S.A., contact us: support@w4global.com