ter.API.EngineSearch
Class Criterion

java.lang.Object
  |
  +--ter.API.EngineSearch.Criterion
Direct Known Subclasses:
AbstractCriterion, ClassCriterion, ConstructorCriterion, FieldCriterion, FinalCriterion, InterfaceCriterion, MethodCriterion, NameCriterion, NameRegexpCriterion, NativeCriterion, packageCriterion, PrivateCriterion, ProtectedCriterion, PublicCriterion, StaticCriterion, StrictCriterion, SynchronizedCriterion, TransientCriterion, VolatileCriterion

public abstract class Criterion
extends java.lang.Object

Title: Criterion

Description: This interface allow to make some new criterion to complete the search engine.

Copyright: Copyright (c) 2003

Company: UNICE

Version:
1.0
Author:
Zerbib Gabriel, Charbit Lucas, Galbois Xavier Gahide Jérôme

Constructor Summary
Criterion()
           
 
Method Summary
 void addNonCompatibilityCriterion(Criterion c)
          Deprecated. you can use it, but it will have no effect because the manager is not implemented yet in the search.
 int getLogicalLink()
           
 java.lang.String getName()
           
 java.util.ArrayList getNonCompatibilityCriterion()
          Deprecated. It was to use with a manager of non compatible criterion, but it is not implemented.
 java.util.ArrayList isAdditionnalGraphicsComponent()
           
 int isCriterionUseable()
           
abstract  boolean isCriterionValid(java.lang.reflect.Member m)
          To implemented for each Criterion
 void setLogicalLink(int ll)
          Change the logical link of the criterion This is very usefull in the EngineSearch.
 void setUseCriterion(int on_off)
          set the status of the criterion ( YES, NOT, DONTMIND)
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Criterion

public Criterion()
Method Detail

getName

public java.lang.String getName()
Returns:
the name of the criterion

setUseCriterion

public void setUseCriterion(int on_off)
                     throws SearchEngineException
set the status of the criterion ( YES, NOT, DONTMIND)

Parameters:
on_off - the status of the criterion.
Throws:
SearchEngineException
See Also:
EngineSearchConst

isCriterionUseable

public int isCriterionUseable()
Returns:
the integer that tells the status of the criterion.

getLogicalLink

public int getLogicalLink()
Returns:
the integer that tells the type of link of the criterion.

setLogicalLink

public void setLogicalLink(int ll)
                    throws SearchEngineException
Change the logical link of the criterion This is very usefull in the EngineSearch.

Parameters:
ll - the new link type ( AND, OR)
Throws:
SearchEngineException
See Also:
EngineSearchConst, EngineSearch

addNonCompatibilityCriterion

public void addNonCompatibilityCriterion(Criterion c)
Deprecated. you can use it, but it will have no effect because the manager is not implemented yet in the search.

Add a criterion that is not compatible with this criterion.

Parameters:
c - the uncompatible criterion

getNonCompatibilityCriterion

public java.util.ArrayList getNonCompatibilityCriterion()
Deprecated. It was to use with a manager of non compatible criterion, but it is not implemented.

return the list of all the criterion that are not compatible whith this one. It's an arrayList of String.

Returns:
the ArrayList of String.

isCriterionValid

public abstract boolean isCriterionValid(java.lang.reflect.Member m)
                                  throws SearchEngineException
To implemented for each Criterion

Parameters:
m - the member that we want to check the validity.
Returns:
true if the Criterion is Valid for this Member
Throws:
SearchEngineException

isAdditionnalGraphicsComponent

public java.util.ArrayList isAdditionnalGraphicsComponent()
Returns:
Empty if there no additionnal graphics component for a criterion
Since:
2.0