com.esri.arcgis.system

Class RateFormat

java.lang.Object

com.esri.arcgis.system.RateFormat

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IClone, INumberFormat, INumberFormatOperations, INumericFormat, IPersist, IPersistStream, IRateFormat, java.io.Externalizable, java.io.Serializable

public class RateFormat
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, INumberFormat, INumericFormat, INumberFormatOperations, IRateFormat, IClone, IPersist, IPersistStream, java.io.Externalizable

COM Class 'RateFormat'. Generated 9/24/2024 11:01:26 AM from 'X:\ArcGIS\com\server\esriSystem.tlb'

Description 'An object for formatting numbers in a rate format.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Fields inherited from interface com.esri.arcgis.system.INumberFormat

IID, IID7e4f470d_8e54_11d2_aad8_000000000000, xxDummy

Fields inherited from interface com.esri.arcgis.system.INumericFormat

IID, IID7e4f4710_8e54_11d2_aad8_000000000000, xxDummy

Fields inherited from interface com.esri.arcgis.system.INumberFormatOperations

IID, IID5ef43b7e_3bc1_4b25_a5c0_08218c75be06, xxDummy

Fields inherited from interface com.esri.arcgis.system.IRateFormat

IID, IID7e4f4717_8e54_11d2_aad8_000000000000, xxDummy

Fields inherited from interface com.esri.arcgis.system.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Constructor Summary

Constructors

Constructor and Description
RateFormat() Constructs a RateFormat using ArcGIS Engine.
RateFormat(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. RateFormat theRateFormat = (RateFormat) obj;

Method Summary

Modifier and Type	Method and Description
void	assign(IClone src) Assigns the properties of src to the receiver.
boolean	equals(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
int	getAlignmentOption() The alignment option applied to the ValueToString method.
int	getAlignmentWidth() The alignment width applied to the ValueToString method.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
double	getRateFactor() The rate factor applied to the ValueToSring and StringToValue methods.
java.lang.String	getRateString() The label appended to the formatted rate number.
int	getRoundingOption() The rounding option applied to the ValueToString method.
int	getRoundingValue() The rounding value, whose meaning depends on the rounding option.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
double	increment(double value) Increments a value according to the numbers format.
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isShowPlusSign() Indicates if formatted numbers contain a plus sign for positive numbers.
boolean	isUseSeparator() Indicates if formatted numbers contain digit grouping symbols.
boolean	isZeroPad() Indicates if formatted numbers contain padded zeros to the right of the decimal.
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release this COM object reference
void	save(IStream pstm, int fClearDirty) save
void	setAlignmentOption(int option) The alignment option applied to the ValueToString method.
void	setAlignmentWidth(int width) The alignment width applied to the ValueToString method.
void	setRateFactor(double factor) The rate factor applied to the ValueToSring and StringToValue methods.
void	setRateString(java.lang.String str) The label appended to the formatted rate number.
void	setRoundingOption(int pption) The rounding option applied to the ValueToString method.
void	setRoundingValue(int value) The rounding value, whose meaning depends on the rounding option.
void	setShowPlusSign(boolean show) Indicates if formatted numbers contain a plus sign for positive numbers.
void	setUseSeparator(boolean sep) Indicates if formatted numbers contain digit grouping symbols.
void	setZeroPad(boolean pad) Indicates if formatted numbers contain padded zeros to the right of the decimal.
double	stringToValue(java.lang.String str) Converts a formatted string to a numeric value.
java.lang.String	valueToString(double value) Converts a numeric value to a formatted string.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

RateFormat

public RateFormat()
           throws java.io.IOException,
                  java.net.UnknownHostException

Constructs a RateFormat using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

RateFormat

public RateFormat(java.lang.Object obj)
           throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RateFormat theRateFormat = (RateFormat) obj;

Construct a RateFormat using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to RateFormat.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

valueToString

public java.lang.String valueToString(double value)
                               throws java.io.IOException,
                                      AutomationException

Converts a numeric value to a formatted string.

Specified by:

valueToString in interface INumberFormat

Parameters:

value - The value (in)

Returns:

The str

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stringToValue

public double stringToValue(java.lang.String str)
                     throws java.io.IOException,
                            AutomationException

Converts a formatted string to a numeric value.

Specified by:

stringToValue in interface INumberFormat

Parameters:

str - The str (in)

Returns:

The value

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRoundingOption

public void setRoundingOption(int pption)
                       throws java.io.IOException,
                              AutomationException

The rounding option applied to the ValueToString method.

Specified by:

setRoundingOption in interface INumericFormat

Parameters:

pption - A com.esri.arcgis.system.esriRoundingOptionEnum constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRoundingOption

public int getRoundingOption()
                      throws java.io.IOException,
                             AutomationException

The rounding option applied to the ValueToString method.

Specified by:

getRoundingOption in interface INumericFormat

Returns:

A com.esri.arcgis.system.esriRoundingOptionEnum constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRoundingValue

public void setRoundingValue(int value)
                      throws java.io.IOException,
                             AutomationException

The rounding value, whose meaning depends on the rounding option.

Specified by:

setRoundingValue in interface INumericFormat

Parameters:

value - The value (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRoundingValue

public int getRoundingValue()
                     throws java.io.IOException,
                            AutomationException

The rounding value, whose meaning depends on the rounding option.

Specified by:

getRoundingValue in interface INumericFormat

Returns:

The value

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAlignmentOption

public void setAlignmentOption(int option)
                        throws java.io.IOException,
                               AutomationException

The alignment option applied to the ValueToString method.

Specified by:

setAlignmentOption in interface INumericFormat

Parameters:

option - A com.esri.arcgis.system.esriNumericAlignmentEnum constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAlignmentOption

public int getAlignmentOption()
                       throws java.io.IOException,
                              AutomationException

The alignment option applied to the ValueToString method.

Specified by:

getAlignmentOption in interface INumericFormat

Returns:

A com.esri.arcgis.system.esriNumericAlignmentEnum constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAlignmentWidth

public void setAlignmentWidth(int width)
                       throws java.io.IOException,
                              AutomationException

The alignment width applied to the ValueToString method.

Specified by:

setAlignmentWidth in interface INumericFormat

Parameters:

width - The width (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAlignmentWidth

public int getAlignmentWidth()
                      throws java.io.IOException,
                             AutomationException

The alignment width applied to the ValueToString method.

Specified by:

getAlignmentWidth in interface INumericFormat

Returns:

The width

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseSeparator

public void setUseSeparator(boolean sep)
                     throws java.io.IOException,
                            AutomationException

Indicates if formatted numbers contain digit grouping symbols.

Specified by:

setUseSeparator in interface INumericFormat

Parameters:

sep - The sep (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseSeparator

public boolean isUseSeparator()
                       throws java.io.IOException,
                              AutomationException

Indicates if formatted numbers contain digit grouping symbols.

Specified by:

isUseSeparator in interface INumericFormat

Returns:

The sep

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setZeroPad

public void setZeroPad(boolean pad)
                throws java.io.IOException,
                       AutomationException

Indicates if formatted numbers contain padded zeros to the right of the decimal.

Specified by:

setZeroPad in interface INumericFormat

Parameters:

pad - The pad (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isZeroPad

public boolean isZeroPad()
                  throws java.io.IOException,
                         AutomationException

Indicates if formatted numbers contain padded zeros to the right of the decimal.

Specified by:

isZeroPad in interface INumericFormat

Returns:

The pad

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowPlusSign

public void setShowPlusSign(boolean show)
                     throws java.io.IOException,
                            AutomationException

Indicates if formatted numbers contain a plus sign for positive numbers.

Specified by:

setShowPlusSign in interface INumericFormat

Parameters:

show - The show (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowPlusSign

public boolean isShowPlusSign()
                       throws java.io.IOException,
                              AutomationException

Indicates if formatted numbers contain a plus sign for positive numbers.

Specified by:

isShowPlusSign in interface INumericFormat

Returns:

The show

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

increment

public double increment(double value)
                 throws java.io.IOException,
                        AutomationException

Increments a value according to the numbers format.

Specified by:

increment in interface INumberFormatOperations

Parameters:

value - The value (in)

Returns:

The result

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRateFactor

public void setRateFactor(double factor)
                   throws java.io.IOException,
                          AutomationException

The rate factor applied to the ValueToSring and StringToValue methods.

Specified by:

setRateFactor in interface IRateFormat

Parameters:

factor - The factor (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRateFactor

public double getRateFactor()
                     throws java.io.IOException,
                            AutomationException

The rate factor applied to the ValueToSring and StringToValue methods.

Specified by:

getRateFactor in interface IRateFormat

Returns:

The factor

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRateString

public void setRateString(java.lang.String str)
                   throws java.io.IOException,
                          AutomationException

The label appended to the formatted rate number.

Specified by:

setRateString in interface IRateFormat

Parameters:

str - The str (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRateString

public java.lang.String getRateString()
                               throws java.io.IOException,
                                      AutomationException

The label appended to the formatted rate number.

Specified by:

getRateString in interface IRateFormat

Returns:

The str

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException