uk.ac.starlink.ttools.cone
Enum UploadFindMode

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

public enum UploadFindMode
extends Enum<UploadFindMode>

Enumeration of ways to run an upload match.

Since:
17 May 2014
Author:
Mark Taylor

Enum Constant Summary
ALL
          All matches.
BEST
          Best remote match only for each input row.
BEST_REMOTE
          Best input match only for each remote row.
EACH
          One row per input row, contains best remote match or blank.
MATCH_COUNT
          One row per input row, just one column giving number of matches.
MATCH_DIST
          One row per input row, just one column giving best match distance.
 
Method Summary
 String getName()
          Returns the one-word name for this mode.
 String getSummary()
          Returns a short text summary of the meaning of this mode.
 boolean isOneToOne()
          Indicates whether this mode describes a match for which the count and sequence of the output table rows are in one to one correspondence with the input table rows.
 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.
 String toString()
           
static UploadFindMode valueOf(String name)
          Returns the enum constant of this type with the specified name.
static UploadFindMode[] 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 UploadFindMode ALL
All matches.


BEST

public static final UploadFindMode BEST
Best remote match only for each input row.


BEST_REMOTE

public static final UploadFindMode BEST_REMOTE
Best input match only for each remote row.


EACH

public static final UploadFindMode EACH
One row per input row, contains best remote match or blank.


MATCH_DIST

public static final UploadFindMode MATCH_DIST
One row per input row, just one column giving best match distance.


MATCH_COUNT

public static final UploadFindMode MATCH_COUNT
One row per input row, just one column giving number of matches.

Method Detail

values

public static final UploadFindMode[] 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(UploadFindMode c : UploadFindMode.values())
        System.out.println(c);

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

valueOf

public static UploadFindMode 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

isOneToOne

public boolean isOneToOne()
Indicates whether this mode describes a match for which the count and sequence of the output table rows are in one to one correspondence with the input table rows.

Returns:
true iff output rows match 1:1 with input rows

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.

If performing the upload match in blocks, a true result from this method may mean that some post-processing of the result needs to be done.

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

toString

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


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