public class DataReturnOption
extends java.lang.Object
implements java.io.Serializable
Spatial analysis data return option class.
This class is mainly used to set some of the options for returning data after the spatial analysis is complete. Including the data return mode, the maximum number of records returned, the result dataset name, how to process the repeated names, etc.
Modifier and Type | Field and Description |
---|---|
DataReturnMode |
dataReturnMode
The data return mode, the default is
DataReturnMode.DATASET_ONLY . |
java.lang.String |
dataset
Set the result dataset ID when
dataReturnMode is DataReturnMode.DATASET_ONLY or DataReturnMode.DATASET_AND_RECORDSET , it is valid, and it is as the name of the returned dataset. |
boolean |
deleteExistResultDataset
If the result data set 's name which the user named is the same as the existing dataset name, whether to delete the existing dataset.
|
int |
expectCount
Set the maximum number of records returned, which is valid when
# dataReturnMode is # RECORDSET_ONLY or # DATASET_AND_RECORDSET , if less than 0 or equals to 0, it means it will return all. |
Constructor and Description |
---|
DataReturnOption()
Default constructor.
|
DataReturnOption(DataReturnOption dataReturnOption)
Copy constructor.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj)
Compares whether the specified object equals to the current
DataReturnOption object. |
int |
hashCode()
Get the hash code of the current data return options.
|
public java.lang.String dataset
dataReturnMode
is DataReturnMode.DATASET_ONLY
or DataReturnMode.DATASET_AND_RECORDSET
, it is valid, and it is as the name of the returned dataset.
The dataset name can not start with a number or an underscore. If dataset
is an empty string, the result dataset is randomly named.
public int expectCount
# dataReturnMode
is # RECORDSET_ONLY
or # DATASET_AND_RECORDSET
, if less than 0 or equals to 0, it means it will return all.public DataReturnMode dataReturnMode
DataReturnMode.DATASET_ONLY
.
When the value is DataReturnMode.RECORDSET_ONLY
, it will not create dataset.
public boolean deleteExistResultDataset
If the result data set 's name which the user named is the same as the existing dataset name, whether to delete the existing dataset.
public DataReturnOption()
Default constructor.
public DataReturnOption(DataReturnOption dataReturnOption)
Copy constructor.
param dataReturnOption Data return options.public boolean equals(java.lang.Object obj)
Compares whether the specified object equals to the current DataReturnOption
object.
equals
in class java.lang.Object
obj
- the object to compare with the current DataReturnOption
object.public int hashCode()
Get the hash code of the current data return options.
hashCode
in class java.lang.Object