SampleType (wizard API)

java.lang.Object

java.lang.Enum<SampleType>

nz.org.riskscape.wizard.model2.smp.SampleType

All Implemented Interfaces:: Serializable, Comparable<SampleType>, Constable

public enum SampleType extends Enum<SampleType>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
Enum Constant Summary

Enum Constants

Enum Constant

Description

ALL_INTERSECTIONS

CENTROID

CLOSEST
Method Summary

Modifier and Type

Method

Description

String

getFunctionCall(String geometry, String coverage)

String

getFunctionCall(String geometry, String coverage, Object... args)

static SampleType

valueOf(String name)

Returns the enum constant of this class with the specified name.

static SampleType[]

values()

Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details
- CENTROID
  
  public static final SampleType CENTROID
- CLOSEST
  
  public static final SampleType CLOSEST
- ALL_INTERSECTIONS
  
  public static final SampleType ALL_INTERSECTIONS
Method Details
- values
  
  public static SampleType[] values()
  
  Returns an array containing the constants of this enum class, in the order they are declared.
  
  Returns:
  
  an array containing the constants of this enum class, in the order they are declared
- valueOf
  
  public static SampleType valueOf(String name)
  
  Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
  
  Parameters:
  
  name - the name of the enum constant to be returned.
  
  Returns:
  
  the enum constant with the specified name
  
  Throws:
  
  IllegalArgumentException - if this enum class has no constant with the specified name
  
  NullPointerException - if the argument is null
- getFunctionCall
  
  public String getFunctionCall(String geometry, String coverage)
  
  Returns:
  
  a Riskscape expression (in String form) to call the appropriate sample function
- getFunctionCall
  
  public String getFunctionCall(String geometry, String coverage, Object... args)
  
  Returns:
  
  a Riskscape expression (in String form) to call the appropriate sample function with additional optional argument values specified