|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.crystaldecisions.sdk.occa.report.data.Formula
public class Formula
This class defines a formula and allows you modify the formula text, its syntax type, and its treatment of null values.
Whenever possible, use the IFormula
interface to manipulate this object.
IReportClientDocument.checkFormula(IFormula)
Constructor Summary | |
---|---|
Formula()
Creates a new IFormula object. |
|
Formula(IFormula src)
Copies the given IFormula object. |
Method Summary | |
---|---|
java.lang.Object |
clone(boolean deepClone)
|
void |
copyTo(java.lang.Object destObject,
boolean deepCopy)
|
java.lang.Object |
createMember(java.lang.String eleName,
org.xml.sax.Attributes attrs,
XMLSerializationContext ctxt,
java.util.Map objState,
boolean[] bLoaded)
For internal use only. |
void |
doControllerModification(java.lang.Object newObject)
For internal use only. |
void |
endElement(java.lang.String eleName,
java.util.Map objState)
For internal use only. |
void |
enumerateMembers(IMemberVisitor visitor)
For internal use only. |
ControllableMixin |
getControllableMixin()
For internal use only. |
FormulaNullTreatment |
getFormulaNullTreatment()
Returns how to treat null values in the evaluation of a formula. |
FormulaSyntax |
getSyntax()
Returns the syntax used to write the formula. |
java.lang.String |
getText()
Returns the formula string. |
boolean |
hasContent(java.lang.Object srcFormula)
|
boolean |
isDirectlyControllable()
For internal use only. |
void |
readElement(java.lang.String eleName,
java.lang.String sVal,
org.xml.sax.Attributes attrs,
java.util.Map objState)
For internal use only. |
void |
save(XMLWriter writer,
java.lang.String sTag,
XMLSerializationContext ctxt)
For internal use only. |
void |
save(XMLWriter writer,
XMLSerializationContext ctxt)
For internal use only. |
void |
saveContents(XMLWriter writer,
XMLSerializationContext ctxt)
For internal use only. |
void |
setFormulaNullTreatment(FormulaNullTreatment treatment)
Sets how to treat null values in the evaluation of a formula. |
void |
setSyntax(FormulaSyntax syntax)
Sets the syntax used to write the formula. |
void |
setText(java.lang.String text)
Sets the formula string. |
void |
startElement(java.lang.String eleName,
java.util.Map objState,
org.xml.sax.Attributes attrs)
For internal use only. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Formula(IFormula src)
IFormula
object.
This constructor makes a deep copy of the src
object.
src
- the object to copypublic Formula()
IFormula
object.
Method Detail |
---|
public FormulaNullTreatment getFormulaNullTreatment()
IFormula
Returns how to treat null values in the evaluation of a formula.
By default, null values are treated as exceptions, which means that as soon as RAS encounters a null valued field in a formula, it immediately stops evaluating the formula and produces no value.
If you want to handle null field values in your formula, you must explicitly do so by adding a test function such as IsNull(). You also have the option to treat nulls as default values. The following are the default values for different types used in a formula.
getFormulaNullTreatment
in interface IFormula
FormulaNullTreatment
object that specifies how to treat
null values in the evaluation of a formula.public FormulaSyntax getSyntax()
IFormula
Returns the syntax used to write the formula.
getSyntax
in interface IFormula
FormulaSyntax
object.public java.lang.String getText()
IFormula
Returns the formula string.
getText
in interface IFormula
String
.public void setSyntax(FormulaSyntax syntax)
IFormula
Sets the syntax used to write the formula.
setSyntax
in interface IFormula
syntax
- The FormulaSyntax
object.public void setText(java.lang.String text)
IFormula
Sets the formula string.
setText
in interface IFormula
text
- The formula as a String
.public java.lang.Object clone(boolean deepClone)
public void copyTo(java.lang.Object destObject, boolean deepCopy)
public boolean hasContent(java.lang.Object srcFormula)
public java.lang.Object createMember(java.lang.String eleName, org.xml.sax.Attributes attrs, XMLSerializationContext ctxt, java.util.Map objState, boolean[] bLoaded)
public void endElement(java.lang.String eleName, java.util.Map objState)
public void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
public void save(XMLWriter writer, java.lang.String sTag, XMLSerializationContext ctxt) throws java.io.IOException
java.io.IOException
public void save(XMLWriter writer, XMLSerializationContext ctxt) throws java.io.IOException
java.io.IOException
public void saveContents(XMLWriter writer, XMLSerializationContext ctxt) throws java.io.IOException
java.io.IOException
public void setFormulaNullTreatment(FormulaNullTreatment treatment)
IFormula
Sets how to treat null values in the evaluation of a formula.
By default, null values are treated as exceptions, which means that as soon as RAS encounters a null valued field in a formula, it immediately stops evaluating the formula and produces no value.
If you want to handle null field values in your formula, you must explicitly do so by adding a test function such as IsNull(). You also have the option to treat nulls as default values. The following are the default values for different types used in a formula.
setFormulaNullTreatment
in interface IFormula
treatment
- The FormulaNullTreatment
object that specifies how to treat null values
in the evaluation of a formula.public void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
public ControllableMixin getControllableMixin()
public void doControllerModification(java.lang.Object newObject) throws ReportSDKException
ReportSDKException
public boolean isDirectlyControllable()
public void enumerateMembers(IMemberVisitor visitor)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |