|
LEONARDI Application Composer - 8.9.0.40 by W4 S.A. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectleon.info.LyTag
leon.info.LyInfo
leon.info.LyFilterRelation
public final class LyFilterRelation
The LyFilterRelation class implements the description of a filter used to filter objects list on
a relation field.
A relation filter is defined by a relation field info and by a filter.
See also tag
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 | |
---|---|
LyFilterRelation()
Constructor of a default relation filter. |
|
LyFilterRelation(LyRelationFieldInfo fieldInfo)
Constructor of a relation filter with a given field info. |
|
LyFilterRelation(LyRelationFieldInfo fieldInfo,
LyFilter filter)
Constructor of an identified relation filter. |
|
LyFilterRelation(java.lang.String id,
LyRelationFieldInfo fieldInfo,
LyFilter filter)
Constructor of an identified relation filter. |
Method Summary | |
---|---|
void |
addAcceptedTargetClassInfo(LyClassInfo targetClassInfo)
(Optional, used by the application) Add a possible target classInfo to the list. |
LyFilterRelation |
cloneFilterRelation()
Clone this relation filter. |
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. |
LyClassInfo |
getAcceptedTargetClassInfos(int index)
Optional info : In order to OPTIMIZE database select, get the accepted target class. |
int |
getAcceptedTargetCount()
Optional info : In order to OPTIMIZE database select, indicate the number of classes which are the accepted as target classes. |
LyClassInfo |
getClassInfo()
Gets the classInfo on which this relation filter applies. |
LyInfoList<LyFieldInfo> |
getFieldInfos()
Gets list of fieldInfos that this filter refers to. |
LyFilter |
getFilter()
Get the filter from this relation filter. |
java.lang.String |
getName()
Returns a displayable string of this element. |
LyInfoList<LyClassInfo> |
getPossibleClasses(boolean notAbstract)
Returns the list of class infos on which the relation filter may be applied. |
LyRelationFieldInfo |
getRelationFieldInfo()
Gets the fieldInfo on which this relation filter 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 |
setClassInfo(LyClassInfo classInfo)
Sets the classInfo on which this expression applies. |
void |
setFilter(LyFilter filter)
Sets the filter to this relation filter. |
void |
setRelationFieldInfo(LyRelationFieldInfo fieldInfo)
Sets the fieldInfo on which this expression applies. |
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 |
---|
public static final java.lang.String __VERSION
Constructor Detail |
---|
public LyFilterRelation(java.lang.String id, LyRelationFieldInfo fieldInfo, LyFilter filter)
id
- The identifier of the object.fieldInfo
- Relation FieldInfo on which this filter expression applies.filter
- Filter used for this relation filter.public LyFilterRelation(LyRelationFieldInfo fieldInfo, LyFilter filter)
fieldInfo
- Relation FieldInfo on which this filter expression applies.filter
- Filter used for this relation filter.public LyFilterRelation(LyRelationFieldInfo fieldInfo)
fieldInfo
- FieldInfo on which this filter expression applies.public LyFilterRelation()
Method Detail |
---|
public boolean match(java.lang.Object object)
match
in interface LyFilterElement
object
- Object to check.
LyFilterElement.match(java.lang.Object)
public boolean match(LyValueSet values)
match
in interface LyFilterElement
values
- Values to check.
LyFilterElement.match(java.lang.Object)
public void lock()
public LyFilterRelation cloneFilterRelation()
public java.lang.String dump()
public void writeXml(java.io.PrintWriter pw)
writeXml
in interface LyFilterElement
pw
- PrintWriter on which the XML is written.public java.lang.String getName()
getName
in interface LyFilterElement
getName
in class LyInfo
public boolean contains(LyFieldInfo fieldInfo)
fieldInfo
- The fieldInfo.
public LyRelationFieldInfo getRelationFieldInfo()
public LyClassInfo getClassInfo()
public LyFilter getFilter()
public LyInfoList<LyFieldInfo> getFieldInfos()
public LyInfoList<LyClassInfo> getPossibleClasses(boolean notAbstract)
notAbstract
- Specifies if the search classInfos must be only concrete classes or not.
public void setRelationFieldInfo(LyRelationFieldInfo fieldInfo)
fieldInfo
- FieldInfo concerned by this filter expression.public void setFilter(LyFilter filter)
filter
- Filter to set to this relation filter.public void setClassInfo(LyClassInfo classInfo)
classInfo
- ClassInfo concerned by this filter expression.public void addAcceptedTargetClassInfo(LyClassInfo targetClassInfo)
classInfo
- target classInfo to look for filteringpublic LyClassInfo getAcceptedTargetClassInfos(int index)
index
- index of the classInfo
public int getAcceptedTargetCount()
|
(c) January 2013 - W4 S.A. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |