org.jamplate.model

Enum Relation

java.lang.Object

java.lang.Enum<Relation>

org.jamplate.model.Relation

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Relation>

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

An enumeration of the possible directions to the relatives of a source.

Since:

0.2.0 ~2021.05.14

Version:

0.2.0

Author:

LSafer

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHILD Child (opposite) When the other source fits inside the source but is not filling it.
NEXT Next (opposite) When the other source occurs after the source.
PARENT Parent (opposite) When the other source can fit the source without being filled.
PREVIOUS Previous (opposite) When the other source occurs before the source.

Method Summary

Modifier and Type	Method and Description
static @Nullable Relation	compute(int i, int j, int s, int e) Calculate the direction from the area [i, j) to the area [s, e).
static @Nullable Relation	compute(@NotNull Reference reference, int s, int e) Calculate the direction from the given reference to the area [s, e).
static @Nullable Relation	compute(@NotNull Reference reference, @NotNull Reference other) Calculate the direction from the given reference to the other.
static @Nullable Relation	compute(@NotNull Tree tree, int s, int e) Calculate the direction from the given sketch to the area [s, e).
static @Nullable Relation	compute(@NotNull Tree tree, @NotNull Reference other) Calculate the direction from the given sketch to the other.
static @Nullable Relation	compute(@NotNull Tree tree, @NotNull Tree other) Calculate the direction from the given sketch to the other.
@NotNull Dominance	dominance() Returns how dominant this direction over the opposite direction.
abstract @NotNull Relation	opposite() The opposite direction of this direction.
@NotNull java.lang.String	toString()
static Relation	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Relation[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PARENT

public static final Relation PARENT

Parent (opposite)
When the other source can fit the source without being filled.

     ...|---|...
     .<------->.
     

     .|--->.....
     .|------->.
     

     .....<---|.
     .<-------|.
 

     (s < i <= j < e)
     (s == i <= j < e)
     (s < i <= j == e)
 

     {s < i} & {j < e}
     {i == s} & {j < e}
     {s < i} & {j == e}
 

Since:

0.2.0 ~2021.05.14

See Also:

Dominance.CONTAIN, Intersection.CONTAINER, Intersection.AHEAD, Intersection.BEHIND

CHILD

public static final Relation CHILD

Child (opposite)
When the other source fits inside the source but is not filling it.

     .<------->.
     ...|---|...
     

     .|------->.
     .|--->.....
     

     .<-------|.
     .....<---|.
 

     (i < s <= e < j)
     (i == s <= e < j)
     (i < s <= e == j)
 

     {i < s} & {e < j}
     {i == s} & {e < j}
     {i < s} & {j == e}
 

Since:

0.2.0 ~2021.05.14

See Also:

Dominance.PART, Intersection.FRAGMENT, Intersection.START, Intersection.END

PREVIOUS

public static final Relation PREVIOUS

Previous (opposite)
When the other source occurs before the source.

     .....|--->.
     .<---|.....
     

     ......|-->.
     .<--|......
 

     (s < e == i < j)
     (s <= e < i <= j)
 

     {s < e} & {e == i} & {i < j}
     {e < i}
 

Since:

0.2.0 ~2021.05.14

See Also:

Dominance.NONE, Intersection.PREVIOUS, Intersection.BEFORE

NEXT

public static final Relation NEXT

Next (opposite)
When the other source occurs after the source.

     .<---|.....
     .....|--->.
     

     .<--|......
     ......|-->.
 

     (i < j == s < e)
     (i <= j < s <= e)
 

     {i < j} & {j == s} & {s < e}
     {j < s}
 

Since:

0.2.0 ~2021.05.14

See Also:

Dominance.NONE, Intersection.NEXT, Intersection.AFTER

Method Detail

values

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

Returns:

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

valueOf

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

compute

@Nullable
 @Contract(pure=true)
public static @Nullable Relation compute(int i,
                                                                           int j,
                                                                           int s,
                                                                           int e)

Calculate the direction from the area [i, j) to the area [s, e).
The direction will be the direction to head from the first area to the second area.
For example: if A is inside B then the direction from A to B will be PARENT.

Parameters:

i - the first index of the first area.

j - one past the last index of the first area.

s - the first index of the second area.

e - one past the last index of the second area.

Returns:

the direction from the first area given to the second area given.

Throws:

java.lang.IllegalArgumentException - if i is not in the range [0, j] or if s is not in the range [0, e].

Since:

0.2.0 ~2021.05.15

compute

@Nullable
 @Contract(pure=true)
public static @Nullable Relation compute(@NotNull
                                                                           @NotNull Reference reference,
                                                                           int s,
                                                                           int e)

Calculate the direction from the given reference to the area [s, e).
The direction will be the direction to head from the first area to the second area.
For example: if A is inside B then the direction from A to B will be PARENT.

Parameters:

reference - the reference (first area).

s - the first index of the second area.

e - one past the last index of the second area.

Returns:

the direction from the given reference to the second area given.

Throws:

java.lang.NullPointerException - if the given reference is null.

java.lang.IllegalArgumentException - if s is not in the range [0, e].

Since:

0.2.0 ~2021.05.15

See Also:

compute(int, int, int, int)

compute

@Nullable
 @Contract(pure=true)
public static @Nullable Relation compute(@NotNull
                                                                           @NotNull Reference reference,
                                                                           @NotNull
                                                                           @NotNull Reference other)

Calculate the direction from the given reference to the other.
The direction will be the direction to head from the first area to the second area.
For example: if A is inside B then the direction from A to B will be PARENT.

Parameters:

reference - the first reference.

other - the second reference.

Returns:

the direction from the given reference to the given other.

Throws:

java.lang.NullPointerException - if the given reference or other is null.

Since:

0.2.0 ~2021.05.15

See Also:

compute(int, int, int, int)

compute

@Nullable
 @Contract(pure=true)
public static @Nullable Relation compute(@NotNull
                                                                           @NotNull Tree tree,
                                                                           int s,
                                                                           int e)

Calculate the direction from the given sketch to the area [s, e).
The direction will be the direction to head from the first area to the second area.
For example: if A is inside B then the direction from A to B will be PARENT.

Parameters:

tree - the sketch (first area).

s - the first index of the second area.

e - one past the last index of the second area.

Returns:

the direction from the given sketch to the second area given.

Throws:

java.lang.NullPointerException - if the given sketch is null.

java.lang.IllegalArgumentException - if s is not in the range [0, e].

Since:

0.2.0 ~2021.01.25

See Also:

compute(int, int, int, int)

compute

@Nullable
 @Contract(pure=true)
public static @Nullable Relation compute(@NotNull
                                                                           @NotNull Tree tree,
                                                                           @NotNull
                                                                           @NotNull Reference other)

Calculate the direction from the given sketch to the other.
The direction will be the direction to head from the first area to the second area.
For example: if A is inside B then the direction from A to B will be PARENT.

Parameters:

tree - the first sketch.

other - the second sketch.

Returns:

the direction from the given sketch to the given other.

Throws:

java.lang.NullPointerException - if the given sketch or other is null.

Since:

0.2.0 ~2021.01.25

See Also:

compute(int, int, int, int)

compute

@Nullable
 @Contract(pure=true)
public static @Nullable Relation compute(@NotNull
                                                                           @NotNull Tree tree,
                                                                           @NotNull
                                                                           @NotNull Tree other)

Calculate the direction from the given sketch to the other.
The direction will be the direction to head from the first area to the second area.
For example: if A is inside B then the direction from A to B will be PARENT.

Parameters:

tree - the first sketch.

other - the second sketch.

Returns:

the direction from the given sketch to the given other.

Throws:

java.lang.NullPointerException - if the given sketch or other is null.

Since:

0.2.0 ~2021.01.25

See Also:

compute(int, int, int, int)

toString

@NotNull
 @Contract(pure=true)
public @NotNull java.lang.String toString()

Overrides:

toString in class java.lang.Enum<Relation>

dominance

@NotNull
 @Contract(pure=true)
public @NotNull Dominance dominance()

Returns how dominant this direction over the opposite direction.

Returns:

how dominant this direction.

Since:

0.2.0 ~2021.01.10

opposite

@NotNull
 @Contract(pure=true)
public abstract @NotNull Relation opposite()

The opposite direction of this direction.

Returns:

the opposite of this.

Since:

0.2.0 ~2021.05.15