com.esri.arcgis.system

Class DateFormat

java.lang.Object

com.esri.arcgis.system.DateFormat

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IClone, IDateFormat, INumberFormat, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class DateFormat
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, INumberFormat, IDateFormat, IClone, IPersist, IPersistStream, java.io.Externalizable

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

Description 'An object for formatting date time.' 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.IDateFormat

IID, IID9fa0d58f_3fc7_45b4_95a3_db8961ed6e00, 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
DateFormat() Constructs a DateFormat using ArcGIS Engine.
DateFormat(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. DateFormat theDateFormat = (DateFormat) 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.
void	fromOADate(double oadate, int[] year, int[] month, int[] day, int[] hour, int[] minute, int[] second, int[] millisecond, int[] dayOfWeek) Convert OADate to date time with the milliseconds preserved.
int	getCalendar() Calendar used for date time formating.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
java.lang.String	getFormat() Format used to convert date time to string, i.e., yyyy/MM/dd.
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.
java.lang.String	getLocale() Locale used for date time formating, i.e., en-US, zh-CN, ja-JP.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
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.
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	setCalendar(int calendarType) Calendar used for date time formating.
void	setFormat(java.lang.String format) Format used to convert date time to string, i.e., yyyy/MM/dd.
void	setLocale(java.lang.String locale) Locale used for date time formating, i.e., en-US, zh-CN, ja-JP.
double	stringToValue(java.lang.String str) Converts a formatted string to a numeric value.
double	toOADate(int year, int month, int day, int hour, int minute, int second, int millisecond) Convert date time to OADate with the milliseconds preserved.
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

DateFormat

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

Constructs a DateFormat using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

DateFormat

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

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

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

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.

setFormat

public void setFormat(java.lang.String format)
               throws java.io.IOException,
                      AutomationException

Format used to convert date time to string, i.e., yyyy/MM/dd.

Specified by:

setFormat in interface IDateFormat

Parameters:

format - The format (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFormat

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

Format used to convert date time to string, i.e., yyyy/MM/dd.

Specified by:

getFormat in interface IDateFormat

Returns:

The format

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLocale

public void setLocale(java.lang.String locale)
               throws java.io.IOException,
                      AutomationException

Locale used for date time formating, i.e., en-US, zh-CN, ja-JP. If not set, the user default locale will be used.

Specified by:

setLocale in interface IDateFormat

Parameters:

locale - The locale (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLocale

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

Locale used for date time formating, i.e., en-US, zh-CN, ja-JP. If not set, the user default locale will be used.

Specified by:

getLocale in interface IDateFormat

Returns:

The locale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCalendar

public void setCalendar(int calendarType)
                 throws java.io.IOException,
                        AutomationException

Calendar used for date time formating. If not set, the default calendar for the locale will be used.

Specified by:

setCalendar in interface IDateFormat

Parameters:

calendarType - A com.esri.arcgis.system.esriCalendarEnum constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCalendar

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

Calendar used for date time formating. If not set, the default calendar for the locale will be used.

Specified by:

getCalendar in interface IDateFormat

Returns:

A com.esri.arcgis.system.esriCalendarEnum constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

toOADate

public double toOADate(int year,
                       int month,
                       int day,
                       int hour,
                       int minute,
                       int second,
                       int millisecond)
                throws java.io.IOException,
                       AutomationException

Convert date time to OADate with the milliseconds preserved.

Specified by:

toOADate in interface IDateFormat

Parameters:

year - The year (in)

month - The month (in)

day - The day (in)

hour - The hour (in)

minute - The minute (in)

second - The second (in)

millisecond - The millisecond (in)

Returns:

The oadate

Throws:

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

AutomationException - If the ArcObject component throws an exception.

fromOADate

public void fromOADate(double oadate,
                       int[] year,
                       int[] month,
                       int[] day,
                       int[] hour,
                       int[] minute,
                       int[] second,
                       int[] millisecond,
                       int[] dayOfWeek)
                throws java.io.IOException,
                       AutomationException

Convert OADate to date time with the milliseconds preserved. Day of week is an integer between 0 and 6, where 0 indicates Sunday and 6 indicates Saturday.

Specified by:

fromOADate in interface IDateFormat

Parameters:

oadate - The oadate (in)

year - The year (out: use single element array)

month - The month (out: use single element array)

day - The day (out: use single element array)

hour - The hour (out: use single element array)

minute - The minute (out: use single element array)

second - The second (out: use single element array)

millisecond - The millisecond (out: use single element array)

dayOfWeek - The dayOfWeek (out: use single element array)

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