LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.info
Class LyStep

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

public final class LyStep
extends LyInfo

This class implements a step between two classes. A step defines how to get objects of a class from objects of an other class using a relation. This step is defined in a source class and has a target class, relation fields between this two classes, a direction used to known how to use those relations and an optional filter for filtering results. A step is defined within a route.

See also tag of leon.dtd.

See Also:
LyRoute

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 dump()
          Returns a string representation of this object.
 LyFilter getFilter()
          Accessor to the filter of this step.
 LyInfoList<LyFieldInfo> getRelations()
          Accessor to relations of this step.
 LyClassInfo getTarget()
          Accessor to the target class of this step.
 boolean isReverse()
          Returns a boolean indicating if relations belong to target class or not (relations are inverted).
 
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
Method Detail

getTarget

public LyClassInfo getTarget()
Accessor to the target class of this step.

Returns:
Target class of this step.

getRelations

public LyInfoList<LyFieldInfo> getRelations()
Accessor to relations of this step. Be careful ! It can contain relations or arrays of relation.

Returns:
List of relation fields of this step (never null, nor empty).

getFilter

public LyFilter getFilter()
Accessor to the filter of this step. This filter is used to filter results.

Returns:
Filter of this step (may be null).

isReverse

public boolean isReverse()
Returns a boolean indicating if relations belong to target class or not (relations are inverted). In that case, the step is said reverse.

Returns:
True is the step is reverse, else false.

dump

public java.lang.String dump()
Returns a string representation of this object.


(c) January 2013 - W4 S.A.

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