JIVE Platform
Release 0.3.1

edu.buffalo.cse.jive.ui.search.pages
Class InvariantViolatedSearchPage

java.lang.Object
  extended by edu.buffalo.cse.jive.ui.search.AbstractJiveSearchPage
      extended by edu.buffalo.cse.jive.ui.search.pages.InvariantViolatedSearchPage
All Implemented Interfaces:
IJiveSearchPage, EventListener, ModifyListener, org.eclipse.swt.internal.SWTEventListener

public class InvariantViolatedSearchPage
extends AbstractJiveSearchPage

An IJiveSearchPage used to create an InvariantViolatedSearchQuery. The page contains input fields for a class, an optional instance number, and an invariant expression in the form of: variableName relationalOperator variableName.

When an instance number is given, the invariant is checked only for that particular instance of the class. When it is left out, the invariant is checked for every instance of the class.

See Also:
InvariantViolatedSearchQuery

Field Summary
protected  Composite control
          The top-level control returned by getControl().
protected  Text leftClassText
          A fully-qualified class name in which the invariant is being checked.
protected  Text leftInstanceText
          An optional instance number specifying what instance of the class should be checked.
protected  Text leftVariableText
          A variable of the class used on the left side of the operator.
protected  Combo operatorCombo
          A relational operator selector.
protected  Text rightVariableText
          A variable of the class used on the right side of the operator.
 
Constructor Summary
InvariantViolatedSearchPage()
           
 
Method Summary
 void createControl(Composite parent)
          Creates the UI controls for the search page.
protected  JiveSearchPattern createPattern(String className, String instanceNumber, String variableName)
          Creates a JiveSearchPattern with the supplied values.
 IJiveSearchQuery createSearchQuery()
          Returns a new IJiveSearchQuery to be used to perform the search.
 Control getControl()
          Returns the page's top-level UI control which was created by IJiveSearchPage.createControl(Composite).
 void initializeInput(ISelection selection)
          Initializes the search page's input fields using the provided ISelection.
 boolean isInputValid()
          Returns whether the search page's input is valid.
 
Methods inherited from class edu.buffalo.cse.jive.ui.search.AbstractJiveSearchPage
getContainer, modifyText, setContainer, updatePerformAction
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

control

protected Composite control
The top-level control returned by getControl().


leftClassText

protected Text leftClassText
A fully-qualified class name in which the invariant is being checked.


leftInstanceText

protected Text leftInstanceText
An optional instance number specifying what instance of the class should be checked.


leftVariableText

protected Text leftVariableText
A variable of the class used on the left side of the operator.


operatorCombo

protected Combo operatorCombo
A relational operator selector.


rightVariableText

protected Text rightVariableText
A variable of the class used on the right side of the operator.

Constructor Detail

InvariantViolatedSearchPage

public InvariantViolatedSearchPage()
Method Detail

createControl

public void createControl(Composite parent)
Description copied from interface: IJiveSearchPage
Creates the UI controls for the search page. The page's top-level UI Control should have the supplied Composite as its parent.

Parameters:
parent - the parent of the page's top-level UI control

getControl

public Control getControl()
Description copied from interface: IJiveSearchPage
Returns the page's top-level UI control which was created by IJiveSearchPage.createControl(Composite).

Returns:
the page's top-level UI control

createSearchQuery

public IJiveSearchQuery createSearchQuery()
Description copied from interface: IJiveSearchPage
Returns a new IJiveSearchQuery to be used to perform the search. This method is called when the Search button is selected.

Returns:
a new search query to be run

createPattern

protected JiveSearchPattern createPattern(String className,
                                          String instanceNumber,
                                          String variableName)
Creates a JiveSearchPattern with the supplied values.

Parameters:
className - a fully-qualified class name
instanceNumber - an instance number
variableName - a variable name
Returns:
the pattern created

initializeInput

public void initializeInput(ISelection selection)
Description copied from interface: IJiveSearchPage
Initializes the search page's input fields using the provided ISelection. This method is called whenever the search page is displayed by the Search dialog.

Parameters:
selection - the current workbench selection

isInputValid

public boolean isInputValid()
Description copied from interface: IJiveSearchPage
Returns whether the search page's input is valid. This method should be called to determine if the Search button should be enabled.

Returns:
true if the input is valid, false otherwise

JIVE Platform
Release 0.3.1