uk.ac.starlink.ttools.cone
Enum CdsFindMode

java.lang.Object
  extended by java.lang.Enum<CdsFindMode>
      extended by uk.ac.starlink.ttools.cone.CdsFindMode
All Implemented Interfaces:
Serializable, Comparable<CdsFindMode>

public enum CdsFindMode
extends Enum<CdsFindMode>

Enumeration of ways to run an upload match using the CDS Xmatch service.

Since:
14 May 2014
Author:
Mark Taylor

Enum Constant Summary
ALL
          All matches.
BEST0
          Best CDS table match for each uploaded table row.
BEST1
          Best uploaded match for each CDS table row.
 
Method Summary
 String getName()
          Returns the one-word name for this mode.
 String getSelectionValue()
          Returns the value of the CDS Xmatch service "selection" parameter to use for this mode.
 String getSummary()
          Returns a short text summary of the meaning of this mode.
 boolean isRemoteUnique()
          Indicates whether the nature of this match requires that each row from the remote table may appear at most once in the result.
 boolean isUploadFirst()
          Indicates the assignment of the uploaded and remote tables as "first" or "second", for the purpose of setting Xmatch service parameters (cat1/2, colDec1/2 etc).
 String toString()
           
static CdsFindMode valueOf(String name)
          Returns the enum constant of this type with the specified name.
static CdsFindMode[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

ALL

public static final CdsFindMode ALL
All matches.


BEST0

public static final CdsFindMode BEST0
Best CDS table match for each uploaded table row.


BEST1

public static final CdsFindMode BEST1
Best uploaded match for each CDS table row.

Method Detail

values

public static final CdsFindMode[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(CdsFindMode c : CdsFindMode.values())
        System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they're declared

valueOf

public static CdsFindMode valueOf(String name)
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 name

getName

public String getName()
Returns the one-word name for this mode.

Returns:
mode name

getSummary

public String getSummary()
Returns a short text summary of the meaning of this mode.

Returns:
mode summary

getSelectionValue

public String getSelectionValue()
Returns the value of the CDS Xmatch service "selection" parameter to use for this mode.

Returns:
"best" or "all"

isUploadFirst

public boolean isUploadFirst()
Indicates the assignment of the uploaded and remote tables as "first" or "second", for the purpose of setting Xmatch service parameters (cat1/2, colDec1/2 etc).

Returns:
if true, uploaded table is table 1 and remote is table 2; if false, it's the other way round

isRemoteUnique

public boolean isRemoteUnique()
Indicates whether the nature of this match requires that each row from the remote table may appear at most once in the result.

Returns:
true iff remote rows must appear <=1 time in result

toString

public String toString()
Overrides:
toString in class Enum<CdsFindMode>


Copyright © 2014 Central Laboratory of the Research Councils. All Rights Reserved.