LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.info
Class LyJoinFilter

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

public final class LyJoinFilter
extends LyInfo
implements LyFilterElement

The LyJoinFilter class implements the description of a filter used to filter objects with a join condition.
A join filter is defined by a source class info (i.e the class to make the join), a source field info, a target field info and by a source filter.

See also tag of leon.dtd

See Also:
LyFilter, LyFilterExpression

Nested Class Summary
 
Nested classes/interfaces inherited from class leon.info.LyTag
LyTag.Model
 
Field Summary
static java.lang.String __VERSION
           
 
Constructor Summary
LyJoinFilter(LyClassInfo classInfo, LyFilter filter, LyFieldInfo source, LyFieldInfo target)
          Constructor of an identified relation filter.
LyJoinFilter(java.lang.String id, LyClassInfo classInfo, LyFilter filter, LyFieldInfo source, LyFieldInfo target)
          Constructor of an identified join filter.
 
Method Summary
 boolean contains(LyFieldInfo fieldInfo)
          Checks if an expression is found concerning the given field info.
 java.lang.String dump()
          Dumps current relation filter as a String.
 LyInfoList<LyFieldInfo> getFieldInfos()
          Gets list of fieldInfos that this filter refers to.
 java.lang.String getName()
          Returns a displayable string of this element.
 LyClassInfo getSourceClassInfo()
          Gets the source class info of this join filter.
 LyFieldInfo getSourceFieldInfo()
          Gets the source fieldInfo on which the join applies.
 LyFilter getSourceFilter()
          Gets the source filter of this join filter.
 LyFieldInfo getTargetFieldInfo()
          Gets the target fieldInfo on which the join applies.
 void lock()
          Lock this relation filter.
 boolean match(LyValueSet values)
          Check if the specified values matches current relation filter.
 boolean match(java.lang.Object object)
          Check if the specified object matches current filter.
 void setSourceClassInfo(LyClassInfo classInfo)
          Sets the source classInfo.
 void setSourceFieldInfo(LyFieldInfo fieldInfo)
          Sets the source fieldInfo.
 void setSourceFilter(LyFilter filter)
          Sets the source filter.
 void setTargetFieldInfo(LyFieldInfo fieldInfo)
          Sets the target fieldInfo.
 void writeXml(java.io.PrintWriter pw)
          Writes XML corresponding to this relation filter element.
 
Methods inherited from class leon.info.LyInfo
getAlias, getApplication, getFile, getId, getInclude, 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

LyJoinFilter

public LyJoinFilter(java.lang.String id,
                    LyClassInfo classInfo,
                    LyFilter filter,
                    LyFieldInfo source,
                    LyFieldInfo target)
Constructor of an identified join filter.

Parameters:
id - The identifier of the object.
fieldInfo - Relation FieldInfo on which this filter expression applies.
filter - Filter used for this relation filter.

LyJoinFilter

public LyJoinFilter(LyClassInfo classInfo,
                    LyFilter filter,
                    LyFieldInfo source,
                    LyFieldInfo target)
Constructor of an identified relation filter.

Parameters:
fieldInfo - Relation FieldInfo on which this filter expression applies.
filter - Filter used for this relation filter.
Method Detail

match

public boolean match(java.lang.Object object)
Check if the specified object matches current filter.

Specified by:
match in interface LyFilterElement
Parameters:
object - Object to check.
Returns:
True if the object matches filter criteria, false otherwise.
See Also:
LyFilterElement.match(java.lang.Object)

match

public boolean match(LyValueSet values)
Check if the specified values matches current relation filter.

Specified by:
match in interface LyFilterElement
Parameters:
values - Values to check.
Returns:
True if the object matches filter criteria, false otherwise.
See Also:
LyFilterElement.match(java.lang.Object)

lock

public void lock()
Lock this relation filter.


dump

public java.lang.String dump()
Dumps current relation filter as a String.

Returns:
String representation of this relation filter.

writeXml

public void writeXml(java.io.PrintWriter pw)
Writes XML corresponding to this relation filter element.

Specified by:
writeXml in interface LyFilterElement
Parameters:
pw - PrintWriter on which the XML is written.

getName

public java.lang.String getName()
Returns a displayable string of this element.

Specified by:
getName in interface LyFilterElement
Overrides:
getName in class LyInfo
Returns:
A displayable string representation of this element.

contains

public boolean contains(LyFieldInfo fieldInfo)
Checks if an expression is found concerning the given field info.

Parameters:
fieldInfo - The fieldInfo.
Returns:
True if an expression with the specified is found, false otherwise.

getSourceClassInfo

public LyClassInfo getSourceClassInfo()
Gets the source class info of this join filter.


getSourceFieldInfo

public LyFieldInfo getSourceFieldInfo()
Gets the source fieldInfo on which the join applies.


getTargetFieldInfo

public LyFieldInfo getTargetFieldInfo()
Gets the target fieldInfo on which the join applies.


getSourceFilter

public LyFilter getSourceFilter()
Gets the source filter of this join filter.

Returns:
Filter of this relation filter.

getFieldInfos

public LyInfoList<LyFieldInfo> getFieldInfos()
Gets list of fieldInfos that this filter refers to.

Returns:
List of fieldInfos that the filter depends on.

setSourceClassInfo

public void setSourceClassInfo(LyClassInfo classInfo)
Sets the source classInfo.

Parameters:
classInfo - source classInfo.

setSourceFieldInfo

public void setSourceFieldInfo(LyFieldInfo fieldInfo)
Sets the source fieldInfo.

Parameters:
fieldInfo - Source fieldInfo.

setTargetFieldInfo

public void setTargetFieldInfo(LyFieldInfo fieldInfo)
Sets the target fieldInfo.

Parameters:
fieldInfo - Target fieldInfo.

setSourceFilter

public void setSourceFilter(LyFilter filter)
Sets the source filter.

Parameters:
filter - Source filter.

(c) January 2013 - W4 S.A.

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