Package uk.ac.starlink.ttools.cone
Enum ConeFindMode
- All Implemented Interfaces:
Serializable
,Comparable<ConeFindMode>
,java.lang.constant.Constable
Find mode for SkyConeMatch2 results.
- Since:
- 26 Sep 2024
- Author:
- Mark Taylor
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum Constants -
Method Summary
Modifier and TypeMethodDescriptionReturns XML description of behaviour.boolean
Indicates if only best matches per query are required.boolean
Indicates if output should include input rows even when no match was found.toString()
static ConeFindMode
Returns the enum constant of this type with the specified name.static ConeFindMode[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
BEST
Best match. -
ALL
All matches. -
EACH
One output row for each input row.
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified nameNullPointerException
- if the argument is null
-
isBestOnly
public boolean isBestOnly()Indicates if only best matches per query are required.- Returns:
- true iff only the best match for each input table row is required, false for all matches within radius
-
isIncludeBlanks
public boolean isIncludeBlanks()Indicates if output should include input rows even when no match was found.- Returns:
- true iff a row is to be output for input rows for which the cone search has no matches
-
getXmlDescription
Returns XML description of behaviour.- Returns:
- XML description, no wrapping element
-
toString
- Overrides:
toString
in classEnum<ConeFindMode>
-