votorola.a.count

Enum XCastRelation

java.lang.Object

java.lang.Enum<XCastRelation>

XCastRelation

All Implemented Interfaces:

Serializable, Comparable<XCastRelation>

public enum XCastRelation
extends Enum<XCastRelation>

The exclusive relation of one person (the person) to another (the anchor) in the votespace of a poll, such as voter or candidate. The following diagram shows the immediate cast relations of a particular anchor. The anchor has a self (s), two voters (v), two co-voters (o), and a candidate (c):

                         ( )  ( )  ( )
                           \   |   /
                            \  |  /
                   ( )  ( )  \ | /
               ( )   \   |    \|/
                 \    \  |    (v)
                  \    \ |     |
                   \    \|     |
                    \   (v)    |    ( )  ( )
            ( )-----( )   \    |     |   /           |
                      \    \   |     |  /            | vote flow
                       \    \  |     | /             V
                        \    \ |     |/
       ( )               \    \|    (o)-----( )
        |        ( )-----(o)  (s)   /
    ( ) |                  \   |   /    ( )
      \ |                   \  |  /      | ( )               ( )( )
       \|                    \ | /       | /                  | /
       ( )       ( )          \|/        |/                   |/
  ( )   |          \  ( )     (c)       ( )----( )           ( )
    \   |  ( )      \  |        \  ( )  /                ( )  |
     \  |  /         \ |         \  |  /                   \  | ( )
      \ | /           \|          \ | /                     \ | /
       \|/            ( )          \|/         ( )           \|/
       ( )              \    ( )---( )   ( )    | ( )        ( )
                         \   /       \   /      | /
                          \ /         \ /       |/
                          ( )         ( )------( )----( )
                            \         /
                             \       /
                             ( )---( )

The scope may be limited to immediate votespace, as shown above, in which case the relation (if any) may be calculated soley from the votes of the two persons. Alternatively the scope may be extended upstream and downstream from the anchor, as illustrated in the extended relations below.

                          (v)  (v)  (v)
                            \   |   /
                             \  |  /
                    (v)  (v)  \ | /
                ( )   \   |    \|/
                  \    \  |    (v)
                   \    \ |     |
                    \    \|     |
                     \   (v)    |    ( )  ( )
             ( )-----( )   \    |     |   /           |
                       \    \   |     |  /            | vote flow
                        \    \  |     | /             V
                         \    \ |     |/
       ( )                \    \|    (o)-----( )
        |         ( )-----(o)  (s)   /
    ( ) |                   \   |   /    ( )
      \ |                    \  |  /      | ( )                ( )( )
       \|                     \ | /       | /                   | /
       ( )        ( )          \|/        |/                    |/
  ( )   |           \  ( )     (c)       ( )----( )            ( )
    \   |  ( )       \  |        \  ( )  /                 ( )  |
     \  |  /          \ |         \  |  /                    \  | ( )
      \ | /            \|          \ | /                      \ | /
       \|/             ( )          \|/         ( )            \|/
       ( )               \    (c)---(c)   ( )    | ( )         ( )
                          \   /       \   /      | /
                           \ /         \ /       |/
                           (c)         (c)------( )----( )
                             \         /
                              \       /
                              (c)---(c)

If the anchor (s) is moved into the cycle at the base of the tree, then base co-candidate relations (b) also appear. The base co-candidates include both root candidates (left and right) and cyclers (center).

                     \    \  |     | /
                      \    \ |     |/
      ( )              \    \|    (v)-----(v)
       |       (v)-----(v)  (v)   /
   ( ) |                 \   |   /    (v)
     \ |                  \  |  /      | (v)               ( )( )
      \|                   \ | /       | /                  | /
      ( )      ( )          \|/        |/                   |/
 ( )   |         \  ( )     (v)       (v)----(v)           ( )
   \   |  ( )     \  |        \  (v)  /                ( )  |
    \  |  /        \ |         \  |  /                   \  | ( )
     \ | /          \|          \ | /                     \ | /
      \|/           ( )          \|/         ( )           \|/
      (b)             \    (b)---(s)   (o)    | ( )        (b)
                       \   /       \   /      | /
                        \ /         \ /       |/
                        (b)         (b)------(o)----( )
                          \         /
                           \       /
                           (b)---(b)


                                   <---at most one relation
 applies for a person at any given moment.  The person is never both a voter and a
 candidate to the anchor even in a tight cycle, but is rather a base co-candidate.  A
 tight cycle is illustrated below, where the cast edges go left and right between the
 person (b) and the anchor (s).

      (v) (v)       (o)
   (v) |  /     (o) /
     \ | /       | /
      \|/  -->   |/
      (s)=======(b)---(o)
           <--difference ordering and shadow lighting.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANDIDATE The person is a recipient of the anchor's vote and the anchor is not a base candidate.
CO_BASE Both the person and the anchor are base candidates.
CO_VOTER Another candidate is the direct recipient of both the person's vote and the anchor's vote.
SELF The person and the anchor are the same.
UNKNOWN The style symbol 'u' for the unknown cast relation.
VOTER The anchor is a recipient of the person's vote and the person is not a base candidate.

Method Summary

Methods

Modifier and Type	Method and Description
char	symbol() Returns the character symbol of the relation.
static XCastRelation	valueOf(String name) Returns the enum constant of this type with the specified name.
static XCastRelation[]	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

SELF

public static final XCastRelation SELF

The person and the anchor are the same. The symbol for this relation is 's'.

VOTER

public static final XCastRelation VOTER

The anchor is a recipient of the person's vote and the person is not a base candidate. The person is a voter to the anchor. The symbol for this relation is 'v'.

See Also:

base candidate

CO_VOTER

public static final XCastRelation CO_VOTER

Another candidate is the direct recipient of both the person's vote and the anchor's vote. The person is a co-voter to the anchor (and vice versa). The symbol for this relation is 'o'.

CO_BASE

public static final XCastRelation CO_BASE

Both the person and the anchor are base candidates. The person is a base co-candidate to the anchor (and vice versa). The symbol for this relation is 'b'.

See Also:

base candidate

CANDIDATE

public static final XCastRelation CANDIDATE

The person is a recipient of the anchor's vote and the anchor is not a base candidate. The person is a candidate to the anchor. The symbol for this relation is 'c'.

See Also:

base candidate

UNKNOWN

public static final XCastRelation UNKNOWN

The style symbol 'u' for the unknown cast relation.

Method Detail

values

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

Returns:

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

valueOf

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

NullPointerException - if the argument is null

symbol

public char symbol()

Returns the character symbol of the relation.