LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.info
Class LyInfo

java.lang.Object
  extended by leon.info.LyTag
      extended by leon.info.LyInfo
All Implemented Interfaces:
java.lang.Cloneable, LyCommentInterface
Direct Known Subclasses:
LyChoiceOption, LyChoiceOptionGroup, LyControl, LyFieldGroup, LyFieldTab, LyFilterCriterion, LyFilterExpression, LyFilterRelation, LyInclude, LyInfoCharType, LyInfoLabel, LyJoinFilter, LyLocation, LyNotifier, LyObjectInfo, LyRegExp, LyRoute, LyRule, LySortCriterion, LyStep, LyUnit, LyUnits

public abstract class LyInfo
extends LyTag
implements LyCommentInterface

This class implements a simple object with an id built when parsing the data model. Its attributes are :


Nested Class Summary
 
Nested classes/interfaces inherited from class leon.info.LyTag
LyTag.Model
 
Field Summary
static java.lang.String __VERSION
           
 
Method Summary
 java.lang.String getAlias()
          Accessor for the alias of the info.
 LyApplication getApplication()
          Accessor for the application to which the info belongs.
 java.lang.String getFile()
          Accessor to the file of this info.
 java.lang.String getId()
          Accessor for the id of the info.
 LyInclude getInclude()
          Gets include from which is info comes from.
 java.lang.String getName()
          Accessor for the name of the info.
 boolean isIncluded()
          Checks if an info is included or not (not declared as extern but loaded by an include).
 boolean isInternal()
          Tests if this info is internal (created by Leonardi) or not.
static boolean isInternal(java.lang.String id)
          Tests if this info is internal (created by Leonardi) or not.
 boolean isLoaded()
          Tests if the class is loaded or not.
 boolean isLocked()
          Checks if this info is locked or not.
 void load()
          Loads when needed a class info from the XML file that contains it.
 void setApplication(LyApplication application)
          Sets the application for this info.
 void setFile(java.lang.String file)
          Sets the file for this info.
 java.lang.String toString()
          Converts this info to a string (returns the id of the info).
 
Methods inherited from class leon.info.LyTag
clone, 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

isInternal

public static final boolean isInternal(java.lang.String id)
Tests if this info is internal (created by Leonardi) or not.


load

public void load()
Loads when needed a class info from the XML file that contains it.

Parameters:
IllegalStateException - If the root element of the XML file is neither a project no a classInfo.
IllegalStateException - If this class info was not found in its XML file.

isLoaded

public boolean isLoaded()
Tests if the class is loaded or not.

Returns:
True if this class is loaded, false otherwise.

getId

public final java.lang.String getId()
Accessor for the id of the info.

Overrides:
getId in class LyTag
Returns:
Idenfifier of the info.

getName

public java.lang.String getName()
Accessor for the name of the info. To be overridden, default implementation returns null.

Returns:
Name of the info.

getAlias

public java.lang.String getAlias()
Accessor for the alias of the info. To be overridden, default implementation calls getName().

Returns:
Alias of the info.

getApplication

public final LyApplication getApplication()
Accessor for the application to which the info belongs.

Overrides:
getApplication in class LyTag
Returns:
Application of the info.

isLocked

public final boolean isLocked()
Checks if this info is locked or not.


getFile

public final java.lang.String getFile()
Accessor to the file of this info.

Returns:
the file of this info.

toString

public final java.lang.String toString()
Converts this info to a string (returns the id of the info).

Overrides:
toString in class java.lang.Object

isIncluded

public final boolean isIncluded()
Checks if an info is included or not (not declared as extern but loaded by an include).

Returns:
True if the info is included, false otherwise.

getInclude

public LyInclude getInclude()
Gets include from which is info comes from.

Returns:
Include if this info belongs to an include, false otherwise.

isInternal

public final boolean isInternal()
Tests if this info is internal (created by Leonardi) or not.


setApplication

public void setApplication(LyApplication application)
Sets the application for this info. Once assigned, the application can be changed.

Parameters:
application - The application to which the info belongs.
Throws:
java.lang.IllegalStateException - If the info already belongs to an application.

setFile

public void setFile(java.lang.String file)
Sets the file for this info.

Parameters:
the - file of this info

(c) January 2013 - W4 S.A.

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