gov.nih.nci.caarray.external.v1_0.query
Enum MatchMode

java.lang.Object
  extended by java.lang.Enum<MatchMode>
      extended by gov.nih.nci.caarray.external.v1_0.query.MatchMode
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<MatchMode>

public enum MatchMode
extends java.lang.Enum<MatchMode>

Enum of constants for different ways of matching an example entity.

Author:
dkokotov

Enum Constant Summary
ANYWHERE
          Match the pattern anywhere in the string.
END
          Match the end of the string to the pattern.
EXACT
          Match the entire string to the pattern.
START
          Match the start of the string to the pattern.
 
Method Summary
 java.lang.String getName()
           
abstract  boolean matches(java.lang.String candidate, java.lang.String target)
          Checks whether the candidate string matches the target string, using the comparison mode for this match mode.
static MatchMode valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static MatchMode[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

EXACT

public static final MatchMode EXACT
Match the entire string to the pattern.


START

public static final MatchMode START
Match the start of the string to the pattern.


END

public static final MatchMode END
Match the end of the string to the pattern.


ANYWHERE

public static final MatchMode ANYWHERE
Match the pattern anywhere in the string.

Method Detail

values

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

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

valueOf

public static MatchMode valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

getName

public java.lang.String getName()
Returns:
the name

matches

public abstract boolean matches(java.lang.String candidate,
                                java.lang.String target)
Checks whether the candidate string matches the target string, using the comparison mode for this match mode.

Parameters:
candidate - the pattern. Must not be null.
target - the string to match the pattern against. Must not be null.
Returns:
whether it matches.