LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.info
Class LyRoute

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

public class LyRoute
extends LyInfo

This class implements a route between two classes. A route defines how to get objects of a class from a list of objects belonging to an other class (cross references). A route is defined in a source class, has a sequence of steps and a target class. A route can be either explicit (defined by programmer in data description file) or implicit (calculated automatically using relations and enabled crossings).

Routes are said reverse if computing should start from target class and returning to source class (this kind of computing is used for optimization purpose). A reverse route contains no steps.

Routes are said bidirectional if they can be used in both directions (from source to target or from target to source).
A route can be complete if the sequence of steps leads to the target class or partial if it gives just a part of the path from to source class to the target class. In this case, the route will be completed by other routes starting from the last class reached by the steps and leading to the target class.

Only complete routes can be bidirectional.
See also tag of leon.dtd.

See Also:
LyStep, LyClassInfo

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.
 java.util.Vector<LyStep> getSteps()
          Accessor to the sequence of steps of this route.
 LyClassInfo getTarget()
          Accessor to the target class of this route.
 void internalCheck(LyClassInfo source)
          Internal method used only by LyObjectList class to check a route defined in a project before beeing used.
 boolean isBidirectional()
          Indicates if this route is bidirectional or not.
 boolean isGenerated()
          Return the generated state of the current route.
 boolean isHidden()
          Indicates if this route is used for computing X-Refs or not.
 boolean isReverse()
          Indicates if this route is reverse or not.
 
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

internalCheck

public void internalCheck(LyClassInfo source)
Internal method used only by LyObjectList class to check a route defined in a project before beeing used.

Parameters:
source - Source class a the route.

getTarget

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

Returns:
Target class of this route.

getSteps

public java.util.Vector<LyStep> getSteps()
Accessor to the sequence of steps of this route. This is a COPY of the internal list, therefore this list may be freely manipulated by the application.

Returns:
Sequence of steps, or null.

isReverse

public boolean isReverse()
Indicates if this route is reverse or not.

Returns:
True if it's reverse, false otherwise.

isBidirectional

public boolean isBidirectional()
Indicates if this route is bidirectional or not.

Returns:
True if the route is bidirectional, false otherwise.

isHidden

public boolean isHidden()
Indicates if this route is used for computing X-Refs or not.

Returns:
True if the route is bidirectional, false otherwise.

dump

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


isGenerated

public boolean isGenerated()
Return the generated state of the current route.

Returns:
true if the route was generated by Leonardi

(c) January 2013 - W4 S.A.

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