com.crystaldecisions.sdk.occa.report.data
Class ConstantValue

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.data.Value
      extended by com.crystaldecisions.sdk.occa.report.data.ConstantValue
All Implemented Interfaces:
IConstantValue, IValue, IClone

public class ConstantValue
extends Value
implements IConstantValue, IClone

This object represents a literal value that needs no evaluation. Expression values, those that need to be evaluated, are stored using the ExpressionValue object. The ConstantValue object is used by the FieldRangeFilterItem object to store values in primitive expressions of filters. When possible, use the IConstantValue.


Constructor Summary
ConstantValue()
           
ConstantValue(IConstantValue src)
           
 
Method Summary
 java.lang.Object clone(boolean deepClone)
           
 int compareValue(ConstantValue arg1)
           Compares the object to the value and returns whether it is equivalent.
 java.lang.String computeText()
          The ComputeText method returns a String representation of the field value that can be used in a report formula.
 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.
 java.lang.String displayText(java.util.Locale locale)
          Returns the field's value as a localized and formatted String.
 void endElement(java.lang.String eleName, java.util.Map objState)
          For internal use only.
 java.lang.Object getValue()
          Returns the value for a constant.
 boolean hasContent(java.lang.Object srcConstantValue)
           
 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 setValue(java.lang.Object value)
          Sets the value for a constant.
 void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
          For internal use only.
 java.lang.String toString()
           
 
Methods inherited from class com.crystaldecisions.sdk.occa.report.data.Value
doControllerModification, enumerateMembers, getControllableMixin, isDirectlyControllable, toComputeText
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ConstantValue

public ConstantValue(IConstantValue src)

ConstantValue

public ConstantValue()
Method Detail

clone

public java.lang.Object clone(boolean deepClone)
Specified by:
clone in class Value

compareValue

public int compareValue(ConstantValue arg1)

Compares the object to the value and returns whether it is equivalent.

Parameters:
arg1 - A com.crystaldecisions.sdk.occa.report.data.ConstantValue to compare with.
Returns:
0 if the values are equal, -1 if the arg1 is greater than this object, and 1 if this object is greater than arg1.

computeText

public java.lang.String computeText()
Description copied from interface: IValue

The ComputeText method returns a String representation of the field value that can be used in a report formula.

The String is not formatted or localized. The syntax will always be Crystal syntax. If the field contains a date, ComputeText returns Date(x, x, x); if it contains a date and time, ComputeText returns DateTime(x, x, x, x, x, x). However, when the date is 1900, 0, 1 (the Java start date), ComputeText returns Time(x, x, x). If you want to set a field to a time value only (that is, with no date), you should set the date to 1900, 0, 1, so that ComputeText will retrieve the correct information.

Specified by:
computeText in interface IValue
Specified by:
computeText in class Value
Returns:
A String representation of the field value that can be used in a report formula.

copyTo

public void copyTo(java.lang.Object destObject,
                   boolean deepCopy)
Specified by:
copyTo in class Value

createMember

public java.lang.Object createMember(java.lang.String eleName,
                                     org.xml.sax.Attributes attrs,
                                     XMLSerializationContext ctxt,
                                     java.util.Map objState,
                                     boolean[] bLoaded)
Description copied from class: Value

For internal use only.

Overrides:
createMember in class Value

displayText

public java.lang.String displayText(java.util.Locale locale)
Description copied from interface: IValue

Returns the field's value as a localized and formatted String. The Locale can be a java.util.Locale value.

The value is formatted according to the locale. The user is required to pass in a locale; the system default locale or user default locale is not used. If the field contains a date, displayText returns a locale-specific date string; if it contains a date and time, displayText returns a locale-specific date time String; if it contains a time String, displayText returns a locale-specific time String.

Specified by:
displayText in interface IValue
Specified by:
displayText in class Value
Parameters:
locale - The locale as specified by java.util.Locale .
Returns:
The field's value as a localized and formatted String.

endElement

public void endElement(java.lang.String eleName,
                       java.util.Map objState)
Description copied from class: Value

For internal use only.

Overrides:
endElement in class Value

getValue

public java.lang.Object getValue()
Description copied from interface: IConstantValue

Returns the value for a constant.

Specified by:
getValue in interface IConstantValue
Returns:
Object

hasContent

public boolean hasContent(java.lang.Object srcConstantValue)
Specified by:
hasContent in class Value

readElement

public void readElement(java.lang.String eleName,
                        java.lang.String sVal,
                        org.xml.sax.Attributes attrs,
                        java.util.Map objState)
Description copied from class: Value

For internal use only.

Overrides:
readElement in class Value

save

public void save(XMLWriter writer,
                 XMLSerializationContext ctxt)
          throws java.io.IOException
Description copied from class: Value

For internal use only.

Overrides:
save in class Value
Throws:
java.io.IOException

save

public void save(XMLWriter writer,
                 java.lang.String sTag,
                 XMLSerializationContext ctxt)
          throws java.io.IOException
Description copied from class: Value

For internal use only.

Overrides:
save in class Value
Throws:
java.io.IOException

saveContents

public void saveContents(XMLWriter writer,
                         XMLSerializationContext ctxt)
                  throws java.io.IOException
Description copied from class: Value

For internal use only.

Overrides:
saveContents in class Value
Throws:
java.io.IOException

setValue

public void setValue(java.lang.Object value)
Description copied from interface: IConstantValue

Sets the value for a constant.

Specified by:
setValue in interface IConstantValue
Parameters:
value - Object

startElement

public void startElement(java.lang.String eleName,
                         java.util.Map objState,
                         org.xml.sax.Attributes attrs)

For internal use only.


toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object