de.ipcon.db.core

Class BenanntPath

java.lang.Object

de.ipcon.db.core.BenanntPath

public class BenanntPath
extends java.lang.Object

This class represents the path to a Benannt in the hierarchy in the Solstice navigation tree. The path may be absolute (starting from the root of the tree) or relative (starting from some given parent).

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	log
static java.lang.String	SEPARATOR

Constructor Summary

Constructors

Constructor and Description
BenanntPath(Benannt ben)
BenanntPath(java.lang.String path)

Method Summary

Modifier and Type	Method and Description
BenanntPath	append(BenanntPath path) Appends the given BenanntPath, which must be relative, to this path.
void	checkClazz(java.lang.Class<? extends Benannt> clazz, Benannt startingPoint)
boolean	equals(java.lang.Object other)
Benannt	getBenannt(BOLoaderI bol, Benannt startingPoint) Finds and returns the Benannt that can be located via this BenanntPath, starting at the passed Benannt (only required if this BenanntPath is relative).
Benannt	getBenannt(BOLoaderI bol, Benannt startingPoint, java.lang.Class<? extends Benannt> clazz)
Benannt	getBenannt(BOLoaderI bol, java.lang.Class<? extends Benannt> clazz) Finds and returns the Benannt that can be located via this (absolute) BenanntPath.
boolean	hasChildren()
boolean	isAbsolute()
static BenanntPath[]	ofMultipathString(java.lang.String multipathString)
java.lang.String[]	split() Splits this BenanntPath around matches of SEPARATOR.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

log

public static final org.apache.log4j.Logger log

SEPARATOR

public static final java.lang.String SEPARATOR

See Also:

Constant Field Values

Constructor Detail

BenanntPath

public BenanntPath(java.lang.String path)

BenanntPath

public BenanntPath(Benannt ben)

Method Detail

ofMultipathString

public static BenanntPath[] ofMultipathString(java.lang.String multipathString)

isAbsolute

public boolean isAbsolute()

Returns:

true if this path is absolute (starting from the root); false otherwise

hasChildren

public boolean hasChildren()

Returns:

true if this path has more than one element; false otherwise

split

public java.lang.String[] split()

Splits this BenanntPath around matches of SEPARATOR. The array returned by this method contains each path part of this BenanntPath that is terminated by a SEPARATOR or is terminated by the end of the path. The path parts in the array are in the order in which they occur in this BenanntPath. If this BenanntPath is absolute, the first element in the returned array will be the empty String, similar to the behaviour you would get if calling String.split(String) on the path with the SEPARATOR as regex parameter.

Returns:

a String array containing each path part of this BenanntPath.

append

public BenanntPath append(BenanntPath path)

Appends the given BenanntPath, which must be relative, to this path.

Throws:

java.lang.IllegalArgumentException - if the passed BenanntPath is absolute

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

getBenannt

public Benannt getBenannt(BOLoaderI bol,
                          java.lang.Class<? extends Benannt> clazz)

Finds and returns the Benannt that can be located via this (absolute) BenanntPath.

Parameters:

bol - a BOLoaderI which is used for loading entries in the navigation tree root

clazz - the Class the wanted Benannt must be of; may be null

Returns:

the Benannt found on the location designated by this path; null if none could be found for some reason

getBenannt

public Benannt getBenannt(BOLoaderI bol,
                          Benannt startingPoint)

Finds and returns the Benannt that can be located via this BenanntPath, starting at the passed Benannt (only required if this BenanntPath is relative).

Parameters:

bol - a BOLoaderI which is used for loading entries in the navigation tree root

startingPoint - the Benannt from which to start "walking" the path; ignored if this path is absolute

clazz - the Class the wanted Benannt must be of; may be null

Returns:

the Benannt found on the location designated by this path; null if none could be found for some reason

getBenannt

public Benannt getBenannt(BOLoaderI bol,
                          Benannt startingPoint,
                          java.lang.Class<? extends Benannt> clazz)

checkClazz

public void checkClazz(java.lang.Class<? extends Benannt> clazz,
                       Benannt startingPoint)