LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.info
Class LyProject

java.lang.Object
  extended by leon.info.LyTag
      extended by leon.info.LyInfo
          extended by leon.info.LyObjectInfo
              extended by leon.info.LyProject
All Implemented Interfaces:
java.lang.Cloneable, LyCommentInterface

public final class LyProject
extends LyObjectInfo

This class is the description of a project. Project is the root object built from parsing the data description file. A project is a simple set of objectInfo instances. It can contain : sub-projects, classes, fields, actions, sorts, filters, locations.

A (root) action can be defined on a project, this action is executed on starting after parsing.

A (root) project may have an application behavior class and a session behavior class. These classes are used to customize the behavior of an application and of a session. They are built by reflection.

Root action and behaviors are not used on sub-projects of the root project.

See also tag of leon.dtd

See Also:
LyClassInfo, LyFieldInfo, LyAction, LyFilter, LySort, LyLocation, LyApplication, LyDataSession

Nested Class Summary
 
Nested classes/interfaces inherited from class leon.info.LyTag
LyTag.Model
 
Field Summary
static java.lang.String __VERSION
           
 
Fields inherited from class leon.info.LyObjectInfo
NULL, PART_ALL, PART_BIND, PART_DATA, PART_GUI, PART_LABEL
 
Method Summary
 void check(LyObjectInfo parent)
          Checks project
 LyAction getAction(int index)
          Returns the action at the given index.
 int getActionCount()
          Returns the number of actions in this project.
 LyInfoList<LyAction> getActions()
          Gets actions list.
 java.lang.Class<?> getApplicationBehaviorClass()
          Returns application behavior class.
 java.lang.String getApplicationBehaviorClassName()
          Gets application behavior class name.
 LyInfoList<LyClassInfo> getClasses()
          Gets classes list.
 LyClassInfo getClassInfo(int index)
          Returns the classInfo at the given index.
 int getClassInfoCount()
          Returns the number of classInfos in this project.
 LyFieldInfo getFieldInfo(int index)
          Returns the fieldInfo at the given index.
 int getFieldInfoCount()
          Returns the number of fieldInfos in this project.
 LyInfoList<LyFieldInfo> getFields()
          Gets fields list.
 LyFilter getFilter(int index)
          Returns the filter at the given index.
 int getFilterCount()
          Returns the number of filters in this project.
 LyInfoList<LyFilter> getFilters()
          Gets filters list.
 LyInfo getInfo(int index)
          Get the LyInfo at the given index.
 int getInfoCount()
          Return the number of infos in this project.
 int getInfoCount(java.lang.Class<? extends LyInfo> infoClass)
          Get the number of infos of the given class in this project.
 LyInfoList<LyInfo> getInfos()
          Get the contents of this project.
<T extends LyInfo>
LyInfoList<T>
getInfos(java.lang.Class<T> infoClass)
          Get the list of infos for the given class.
 LyInfoList<LyClassInfo> getLoadedClasses()
          Gets list of loaded classes of this project.
 LyLocation getLocation(int index)
          Returns the location at the given index.
 int getLocationCount()
          Returns the number of locations in this project.
 LyInfoList<LyLocation> getLocations()
          Gets locations list.
 LyModel getModel(java.lang.String type)
          To get a model of this project by its type.
 java.util.Vector<LyModel> getModels()
          To get the models of this project.
 int getModelsCount()
          Returns the number of models in this project.
 LyNotifier getNotifier(int index)
          Returns the notifier at the given index.
 int getNotifierCount()
          Returns the number of notifiers in this project.
 LyInfoList<LyNotifier> getNotifiers()
          Gets notifiers of this project.
 LyProject getProject(int index)
          Returns the sub-project at the given index.
 LyProject getProject(java.lang.String projectId)
          Returns the project with the given identifier.
 int getProjectCount()
          Returns the number of sub-projects in this project.
 LyInfoList<LyProject> getProjects()
          Gets projects list.
 LyAction getRootAction()
          Returns root action of this project.
 java.lang.Class<?> getSessionBehaviorClass()
          Return session behavior class.
 java.lang.String getSessionBehaviorClassName()
          Gets session behavior class name.
 LySort getSort(int index)
          Returns the sort at the given index.
 int getSortCount()
          Returns the number of sorts in this project.
 LyInfoList<LySort> getSorts()
          Gets sorts list.
 java.lang.String getVersion()
          Gets version of this project.
 boolean hasInfo(LyInfo info)
          Checks if given info is registered in this project.
 void lock()
          Lock this project.
 
Methods inherited from class leon.info.LyObjectInfo
clone, getAlias, getData, getDataList, getDatas, getFilePrefix, getGroup, getInternalAlias, getInternalFilePrefix, getInternalName, getMarks, getName, getTemplate, getTip, getUserData, hasMark, hasMarks, hasTemplate, isTemplate, putData, putData, removeData, toName
 
Methods inherited from class leon.info.LyInfo
getApplication, getFile, getId, getInclude, isIncluded, isInternal, isInternal, isLoaded, isLocked, load, setApplication, setFile, toString
 
Methods inherited from class leon.info.LyTag
getCommentsEnd, getCommentsStart, getEnvironment, getModelType, getParent, getRootProject, hasAncestor, isExtern, setCommentsEnd, setCommentsStart, wasCloned
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface leon.parser.LyCommentInterface
getCommentsEnd, getCommentsStart, setCommentsEnd, setCommentsStart
 

Field Detail

__VERSION

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

check

public void check(LyObjectInfo parent)
Checks project

Parameters:
parent - Parent of this object info for this check : this means context of use of this instance (classInfo which declares the field, project that contains the classInfo...).

lock

public void lock()
Lock this project.


getApplicationBehaviorClassName

public final java.lang.String getApplicationBehaviorClassName()
Gets application behavior class name.

Returns:
Java name of application behavior class (may be null).

getApplicationBehaviorClass

public java.lang.Class<?> getApplicationBehaviorClass()
Returns application behavior class.

Returns:
Returns java class that is used to customize behavior of an application.

getSessionBehaviorClassName

public final java.lang.String getSessionBehaviorClassName()
Gets session behavior class name.

Returns:
Java name of session behavior class (may be null).

getSessionBehaviorClass

public java.lang.Class<?> getSessionBehaviorClass()
Return session behavior class.

Returns:
Returns java class that is used to customize behavior of a session.

getVersion

public java.lang.String getVersion()
Gets version of this project.

Returns:
Version.

getProject

public LyProject getProject(int index)
Returns the sub-project at the given index.

Parameters:
index - Index of the requested project.
Returns:
The project if it's found, null otherwise.

getProjectCount

public int getProjectCount()
Returns the number of sub-projects in this project.

Returns:
Number of classInfos in this project.

getProjects

public LyInfoList<LyProject> getProjects()
Gets projects list.

Returns:
List of sub-projects of this project.

getProject

public LyProject getProject(java.lang.String projectId)
Returns the project with the given identifier.

Parameters:
projectId - the identifier of the project that must be retrieved
Returns:
the sub-project with the given identifier (may be the project itself)

getClassInfo

public LyClassInfo getClassInfo(int index)
Returns the classInfo at the given index.

Parameters:
index - Index of the requested classInfo.
Returns:
The classInfo if it's found, null otherwise.

getClassInfoCount

public int getClassInfoCount()
Returns the number of classInfos in this project.

Returns:
Number of classInfos in this project.

getClasses

public LyInfoList<LyClassInfo> getClasses()
Gets classes list.

Returns:
List of classes of this project.

getLoadedClasses

public LyInfoList<LyClassInfo> getLoadedClasses()
Gets list of loaded classes of this project.

Returns:
List of loaded classes of this project.

getAction

public LyAction getAction(int index)
Returns the action at the given index.

Parameters:
index - Index of the requested action.
Returns:
The action if it's found, null otherwise.

getActionCount

public int getActionCount()
Returns the number of actions in this project.

Returns:
Number of actions in this project.

getActions

public LyInfoList<LyAction> getActions()
Gets actions list.

Returns:
List of actions of this project.

getFieldInfo

public LyFieldInfo getFieldInfo(int index)
Returns the fieldInfo at the given index.

Parameters:
index - Index of the requested fieldInfo.
Returns:
The fieldInfo if it's found, null otherwise.

getFieldInfoCount

public int getFieldInfoCount()
Returns the number of fieldInfos in this project.

Returns:
Number of fieldInfos in this project.

getFields

public LyInfoList<LyFieldInfo> getFields()
Gets fields list.

Returns:
List of fields registered on this project.

getFilter

public LyFilter getFilter(int index)
Returns the filter at the given index.

Parameters:
index - Index of the requested filter.
Returns:
The filter if it's found, null otherwise.

getFilterCount

public int getFilterCount()
Returns the number of filters in this project.

Returns:
Number of filters in this project.

getFilters

public LyInfoList<LyFilter> getFilters()
Gets filters list.

Returns:
List of filters registered on this project.

getSort

public LySort getSort(int index)
Returns the sort at the given index.

Parameters:
index - Index of the requested sort.
Returns:
The sort if it's found, null otherwise.

getSortCount

public int getSortCount()
Returns the number of sorts in this project.

Returns:
Number of sorts in this project.

getSorts

public LyInfoList<LySort> getSorts()
Gets sorts list.

Returns:
List of sorts registered on this project.

getLocation

public LyLocation getLocation(int index)
Returns the location at the given index.

Parameters:
index - Index of the requested location.
Returns:
The location if it's found, null otherwise.

getLocationCount

public int getLocationCount()
Returns the number of locations in this project.

Returns:
Number of locations in this project.

getLocations

public LyInfoList<LyLocation> getLocations()
Gets locations list.

Returns:
List of locations registered on this project.

getNotifier

public LyNotifier getNotifier(int index)
Returns the notifier at the given index.

Parameters:
index - Index of the requested notifier.
Returns:
The notifier if it's found, null otherwise.

getNotifierCount

public int getNotifierCount()
Returns the number of notifiers in this project.

Returns:
Number of notifiers in this project.

getNotifiers

public LyInfoList<LyNotifier> getNotifiers()
Gets notifiers of this project.

Returns:
notifiers.

getInfos

public LyInfoList<LyInfo> getInfos()
Get the contents of this project.

Returns:
the contents of this project

getInfo

public LyInfo getInfo(int index)
Get the LyInfo at the given index.

Parameters:
index - index of the requested LyInfo
Returns:
the info if it's found, null otherwise

getInfoCount

public int getInfoCount()
Return the number of infos in this project.

Returns:
Number of infos in this project.

hasInfo

public boolean hasInfo(LyInfo info)
Checks if given info is registered in this project.

Returns:
True if info is known, false otherwise.

getInfos

public <T extends LyInfo> LyInfoList<T> getInfos(java.lang.Class<T> infoClass)
Get the list of infos for the given class.

Parameters:
infoClass - the class for the info
Returns:
the list of info of the given class

getInfoCount

public int getInfoCount(java.lang.Class<? extends LyInfo> infoClass)
Get the number of infos of the given class in this project.

Parameters:
infoClass - the class for the info
Returns:
the number of infos of the given class in this project

getRootAction

public LyAction getRootAction()
Returns root action of this project.

Returns:
Root action if any, null otherwise.

getModel

public LyModel getModel(java.lang.String type)
To get a model of this project by its type.

Parameters:
type - Type of the searched model

getModelsCount

public int getModelsCount()
Returns the number of models in this project.

Returns:
Number of models in this project.

getModels

public java.util.Vector<LyModel> getModels()
To get the models of this project.


(c) January 2013 - W4 S.A.

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