LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.info
Class LyPath

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

public class LyPath
extends LyRoute

This class defines a path.


Nested Class Summary
 
Nested classes/interfaces inherited from class leon.info.LyTag
LyTag.Model
 
Field Summary
static java.lang.String __VERSION
           
 
Constructor Summary
LyPath(java.lang.String id, LyClassInfo target, LyClassInfo classInfo, LyFieldInfo fieldInfo)
          Constructor of a path.
LyPath(java.lang.String id, LyClassInfo target, LyClassInfo classInfo, LyFieldInfo fieldInfo, LyInfoLabel fieldLabel)
          Constructor of a path.
 
Method Summary
 void addStep(LyClassInfo target, LyInfoList<LyFieldInfo> relations, LyFilter filter, boolean reverse)
          Adds a step to this path.
 void check()
          Check consistency of this path.
 LyInfoLabel getFieldLabel()
          Gets label to use on target field.
 LyClassInfo getSourceClassInfo()
          Gets source classInfo of the path.
 java.lang.String getString(LyClassInfo classInfo, LyUnit unit)
          Gets string corresponding to this path for the given class info.
 java.lang.String getString(LyObject object, LyUnit unit)
          Gets string corresponding to this path for the given object.
 LyFieldInfo getTargetFieldInfo()
          Gets target fieldinfo of the path.
 
Methods inherited from class leon.info.LyRoute
dump, getSteps, getTarget, internalCheck, isBidirectional, isGenerated, isHidden, isReverse
 
Methods inherited from class leon.info.LyInfo
getAlias, getApplication, getFile, getId, getInclude, getName, isIncluded, isInternal, isInternal, isLoaded, isLocked, load, setApplication, setFile, toString
 
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
Constructor Detail

LyPath

public LyPath(java.lang.String id,
              LyClassInfo target,
              LyClassInfo classInfo,
              LyFieldInfo fieldInfo)
Constructor of a path.

Parameters:
id - Id of the path.
target - Target classinfo of the path.
classInfo - Source classinfo of the path.
fieldinfo - Target fieldinfo of the path.
fieldLabel - Label to use on target field.

LyPath

public LyPath(java.lang.String id,
              LyClassInfo target,
              LyClassInfo classInfo,
              LyFieldInfo fieldInfo,
              LyInfoLabel fieldLabel)
Constructor of a path.

Parameters:
id - Id of the path.
target - Target classinfo of the path.
classInfo - Source classinfo of the path.
fieldinfo - Target fieldinfo of the path.
fieldLabel - Label to use on target field.
Method Detail

check

public void check()
Check consistency of this path.


getTargetFieldInfo

public final LyFieldInfo getTargetFieldInfo()
Gets target fieldinfo of the path.


getSourceClassInfo

public final LyClassInfo getSourceClassInfo()
Gets source classInfo of the path.


getFieldLabel

public final LyInfoLabel getFieldLabel()
Gets label to use on target field.


getString

public java.lang.String getString(LyObject object,
                                  LyUnit unit)
Gets string corresponding to this path for the given object.


getString

public java.lang.String getString(LyClassInfo classInfo,
                                  LyUnit unit)
Gets string corresponding to this path for the given class info.


addStep

public void addStep(LyClassInfo target,
                    LyInfoList<LyFieldInfo> relations,
                    LyFilter filter,
                    boolean reverse)
Adds a step to this path.

Parameters:
target - Target class of the added step.
relation - List of relations for the added step.
filter - Filter of the added step (can be null)
reverse - Boolean indicating the direction of the added step.
Throws:
java.lang.IllegalArgumentException - If target parameter is null.
java.lang.IllegalArgumentException - If relations parameter is null or if the list is empty.

(c) January 2013 - W4 S.A.

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