jimm.datavision
Class SuppressionProc

java.lang.Object
  extended by jimm.datavision.SuppressionProc
All Implemented Interfaces:
Writeable

public class SuppressionProc
extends java.lang.Object
implements Writeable

A suppression proc is an object used to decide if data should be displayed or not. It returns true if the data should be displayed or false if the data should be supressed (should not be displayed).

Author:
Jim Menard, jimm@io.com

Field Summary
protected  Formula formula
           
protected  boolean hiding
           
protected  Report report
           
 
Constructor Summary
SuppressionProc(Report report)
           
 
Method Summary
 Formula getFormula()
          Returns formula used when not hiding.
 boolean isHidden()
           
 boolean refersTo(Field f)
           
 boolean refersTo(Formula f)
           
 boolean refersTo(Parameter p)
           
 boolean refersTo(UserColumn uc)
           
 void setHidden(boolean val)
           
 boolean suppress()
          Returns true if the data should be suppressed (not displayed).
 void writeXML(XMLWriter out)
          Writes this suppression proc as an XML tag.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

formula

protected Formula formula

report

protected Report report

hiding

protected boolean hiding
Constructor Detail

SuppressionProc

public SuppressionProc(Report report)
Method Detail

isHidden

public boolean isHidden()

setHidden

public void setHidden(boolean val)

getFormula

public Formula getFormula()
Returns formula used when not hiding.

Returns:
formula used when not hiding

refersTo

public boolean refersTo(Field f)

refersTo

public boolean refersTo(Formula f)

refersTo

public boolean refersTo(UserColumn uc)

refersTo

public boolean refersTo(Parameter p)

suppress

public boolean suppress()
Returns true if the data should be suppressed (not displayed). Returns false if the data should not be supressed (it should be displayed).

Returns:
true if the data should be suppressed (not displayed)

writeXML

public void writeXML(XMLWriter out)
Writes this suppression proc as an XML tag.

Specified by:
writeXML in interface Writeable
Parameters:
out - a writer that knows how to write XML