com.esri.arcgis.datasourcesraster

Class SpectralSample

java.lang.Object

com.esri.arcgis.datasourcesraster.SpectralSample

All Implemented Interfaces:

ISpectralSample, com.esri.arcgis.interop.RemoteObjRef, IXMLSerialize, java.io.Serializable

public class SpectralSample
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ISpectralSample, IXMLSerialize

COM Class 'SpectralSample'. Generated 9/23/2025 7:46:19 AM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description 'The Spectral Sample class that holds spectral data.' 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 inherited from interface com.esri.arcgis.datasourcesraster.ISpectralSample

IID, IIDfe137721_c242_4515_b499_6a55262da6e7, xxDummy

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

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	create(GUID sampleId, java.lang.String sampleName, GUID sensorId, IDoubleArray pReflectanceData, double scaleFactor) Creates the object from parameters.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(java.lang.Object o) Compare this object with another
IPropertySet	getCharacteristics() Gets the list of Spectral Sample properties specific for the library type.
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.
java.lang.String	getName() Gets the Spectral Sample name.
IDoubleArray	getReflectanceData() Gets the array of reflectance data.
GUID	getSampleId() Gets the Spectral Sample Id.
double	getScaleFactor() Gets the Scale Factor value.
GUID	getSensorId() Gets the Spectral Sensor Id that holds the wavelengths for this Sample.
int	hashCode() the hashcode for this object
void	release() Release this COM object reference
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setCharacteristics(IPropertySet ppCharacteristics) Gets the list of Spectral Sample properties specific for the library type.
void	setName(java.lang.String pSampleName) Gets the Spectral Sample name.
void	setReflectanceData(IDoubleArray ppReflectanceData) Gets the array of reflectance data.
void	setSampleId(GUID pSampleID) Gets the Spectral Sample Id.
void	setScaleFactor(double pScaleFactor) Gets the Scale Factor value.
void	setSensorId(GUID pSensorID) Gets the Spectral Sensor Id that holds the wavelengths for this Sample.
void	uSGSBasicLoad(java.lang.String path, boolean createId) Loads the basic characteristics of a Spectral Sample located in the specified path.
void	uSGSFullyLoad(java.lang.String path, boolean createId) Loads all the properties of a Spectral Sample, including reflectance data, located in the specified path.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpectralSample

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

Constructs a SpectralSample using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

SpectralSample

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

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

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

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

getSampleId

public GUID getSampleId()
                 throws java.io.IOException,
                        AutomationException

Gets the Spectral Sample Id.

Specified by:

getSampleId in interface ISpectralSample

Returns:

A Structure: com.esri.arcgis.support.ms.stdole.GUID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSampleId

public void setSampleId(GUID pSampleID)
                 throws java.io.IOException,
                        AutomationException

Gets the Spectral Sample Id.

Specified by:

setSampleId in interface ISpectralSample

Parameters:

pSampleID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

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

Gets the Spectral Sample name.

Specified by:

getName in interface ISpectralSample

Returns:

The pSampleName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(java.lang.String pSampleName)
             throws java.io.IOException,
                    AutomationException

Gets the Spectral Sample name.

Specified by:

setName in interface ISpectralSample

Parameters:

pSampleName - The pSampleName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSensorId

public GUID getSensorId()
                 throws java.io.IOException,
                        AutomationException

Gets the Spectral Sensor Id that holds the wavelengths for this Sample.

Specified by:

getSensorId in interface ISpectralSample

Returns:

A Structure: com.esri.arcgis.support.ms.stdole.GUID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSensorId

public void setSensorId(GUID pSensorID)
                 throws java.io.IOException,
                        AutomationException

Gets the Spectral Sensor Id that holds the wavelengths for this Sample.

Specified by:

setSensorId in interface ISpectralSample

Parameters:

pSensorID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getReflectanceData

public IDoubleArray getReflectanceData()
                                throws java.io.IOException,
                                       AutomationException

Gets the array of reflectance data.

Specified by:

getReflectanceData in interface ISpectralSample

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setReflectanceData

public void setReflectanceData(IDoubleArray ppReflectanceData)
                        throws java.io.IOException,
                               AutomationException

Gets the array of reflectance data.

Specified by:

setReflectanceData in interface ISpectralSample

Parameters:

ppReflectanceData - A reference to a com.esri.arcgis.system.IDoubleArray (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getScaleFactor

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

Gets the Scale Factor value.

Specified by:

getScaleFactor in interface ISpectralSample

Returns:

The pScaleFactor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setScaleFactor

public void setScaleFactor(double pScaleFactor)
                    throws java.io.IOException,
                           AutomationException

Gets the Scale Factor value.

Specified by:

setScaleFactor in interface ISpectralSample

Parameters:

pScaleFactor - The pScaleFactor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCharacteristics

public IPropertySet getCharacteristics()
                                throws java.io.IOException,
                                       AutomationException

Gets the list of Spectral Sample properties specific for the library type.

Specified by:

getCharacteristics in interface ISpectralSample

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCharacteristics

public void setCharacteristics(IPropertySet ppCharacteristics)
                        throws java.io.IOException,
                               AutomationException

Gets the list of Spectral Sample properties specific for the library type.

Specified by:

setCharacteristics in interface ISpectralSample

Parameters:

ppCharacteristics - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

uSGSBasicLoad

public void uSGSBasicLoad(java.lang.String path,
                          boolean createId)
                   throws java.io.IOException,
                          AutomationException

Loads the basic characteristics of a Spectral Sample located in the specified path. No spectral data is loaded.

Specified by:

uSGSBasicLoad in interface ISpectralSample

Parameters:

path - The path (in)

createId - The createId (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

uSGSFullyLoad

public void uSGSFullyLoad(java.lang.String path,
                          boolean createId)
                   throws java.io.IOException,
                          AutomationException

Loads all the properties of a Spectral Sample, including reflectance data, located in the specified path.

Specified by:

uSGSFullyLoad in interface ISpectralSample

Parameters:

path - The path (in)

createId - The createId (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

create

public void create(GUID sampleId,
                   java.lang.String sampleName,
                   GUID sensorId,
                   IDoubleArray pReflectanceData,
                   double scaleFactor)
            throws java.io.IOException,
                   AutomationException

Creates the object from parameters.

Specified by:

create in interface ISpectralSample

Parameters:

sampleId - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

sampleName - The sampleName (in)

sensorId - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

pReflectanceData - A reference to a com.esri.arcgis.system.IDoubleArray (in)

scaleFactor - The scaleFactor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Serializes an object to XML.

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Deserializes an object from XML.

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.