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

java.lang.Object
  |
  +--com.crystaldecisions.sdk.occa.report.data.Value
        |
        +--com.crystaldecisions.sdk.occa.report.data.ParameterFieldValue
              |
              +--com.crystaldecisions.sdk.occa.report.data.ParameterFieldDiscreteValue
All Implemented Interfaces:
IClone, IParameterFieldDiscreteValue, IParameterFieldValue, IValue

public class ParameterFieldDiscreteValue
extends ParameterFieldValue
implements IParameterFieldDiscreteValue, IClone

This object represents a discrete value belonging to a parameter. A discrete value is a value that does not have a range--that is, it is singular. Examples of discrete values are: 1, 56.4, "Jeremy", and so on. When possible, use the interfaces IParameterFieldValue and IValue to manipulate this object.


Constructor Summary
ParameterFieldDiscreteValue()
           
ParameterFieldDiscreteValue(IParameterFieldDiscreteValue src)
           
 
Method Summary
 java.lang.Object clone(boolean deepClone)
          Returns the new object that has been cloned.
 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)
          Copies the object.
 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 discrete value of the parameter.
 boolean hasContent(java.lang.Object srcParameterFieldDiscreteValue)
          Returns true if this object contains the same elements as the passed in object.
 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 discrete value of the parameter.
 void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
          For internal use only.
 
Methods inherited from class com.crystaldecisions.sdk.occa.report.data.ParameterFieldValue
getDescription, setDescription, startElement
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.data.IParameterFieldValue
getDescription, setDescription
 

Constructor Detail

ParameterFieldDiscreteValue

public ParameterFieldDiscreteValue(IParameterFieldDiscreteValue src)

ParameterFieldDiscreteValue

public ParameterFieldDiscreteValue()
Method Detail

clone

public java.lang.Object clone(boolean deepClone)
Description copied from interface: IClone

Returns the new object that has been cloned.

Specified by:
clone in interface IClone
Specified by:
clone in class ParameterFieldValue
Parameters:
deepClone - true to use deep clone, false to use shallow.
Returns:
The new object that has been cloned.

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)
Description copied from interface: IClone

Copies the object.

Specified by:
copyTo in interface IClone
Overrides:
copyTo in class ParameterFieldValue
Parameters:
destObject - The destination object to copy to.
deepCopy - true to use deep copy, false to use shallow.

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 ParameterFieldValue

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 ParameterFieldValue

getValue

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

Returns the discrete value of the parameter.

Specified by:
getValue in interface IParameterFieldDiscreteValue
Returns:
The value as an object.

hasContent

public boolean hasContent(java.lang.Object srcParameterFieldDiscreteValue)
Description copied from interface: IClone

Returns true if this object contains the same elements as the passed in object.

Specified by:
hasContent in interface IClone
Overrides:
hasContent in class ParameterFieldValue
Parameters:
srcParameterFieldDiscreteValue - The object to check for content.
Returns:
true if this object contains the same elements as the passed in object, otherwise false.

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 ParameterFieldValue

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 ParameterFieldValue
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 ParameterFieldValue
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 ParameterFieldValue
java.io.IOException

setValue

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

Sets the discrete value of the parameter.

Specified by:
setValue in interface IParameterFieldDiscreteValue
Parameters:
value - The value as an object.

startElement

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

For internal use only.