hu.ibello.search

Enum PositionType

java.lang.Object

java.lang.Enum<PositionType>

hu.ibello.search.PositionType

All Implemented Interfaces:

Serializable, Comparable<PositionType>

public enum PositionType
extends Enum<PositionType>

Constants of this enum specifies the relative position of an element from an anchor element.

The values are used in Position.type() annotation property.

About ibello search engine see hu.ibello.search.

Author:

Kornél Simon

See Also:

Position

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABOVE The desired element is above the anchor element.
BELOW The desired element is below the anchor element.
COLUMN The desired element is in the same column as the anchor element.
LEFT_FROM The desired element is left from the anchor element.
RIGHT_FROM The desired element is right from the anchor element.
ROW The desired element is in the same row as the anchor element.

Method Summary

Modifier and Type	Method and Description
static PositionType	valueOf(String name) Returns the enum constant of this type with the specified name.
static PositionType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ROW

public static final PositionType ROW

The desired element is in the same row as the anchor element. It means that the horizontal center line of the anchor should fit into the boundaries of the desired element.

COLUMN

public static final PositionType COLUMN

The desired element is in the same column as the anchor element. It means that the vertical center line of the anchor should fit into the boundaries of the desired element.

LEFT_FROM

public static final PositionType LEFT_FROM

The desired element is left from the anchor element. It means that the x coordinate of the desired element's right edge if less than or equal to the x coordinate of the anchor element's left edge.

RIGHT_FROM

public static final PositionType RIGHT_FROM

The desired element is right from the anchor element. It means that the x coordinate of the desired element's left edge if greater than or equal to the x coordinate of the anchor element's right edge.

ABOVE

public static final PositionType ABOVE

The desired element is above the anchor element. It means that the bottom y coordinate of the desired element is less than or equal to the top y coordinate of the anchor element.

BELOW

public static final PositionType BELOW

The desired element is below the anchor element. It means that the top y coordinate of the desired element is greater than or equal to the bottom y coordinate of the anchor element.

Method Detail

values

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

Returns:

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

valueOf

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