Package com.saperion.common.lang.id

Class HierarchicalName

java.lang.Object

com.saperion.common.lang.id.StringId

com.saperion.common.lang.id.HierarchicalName

All Implemented Interfaces:

Id, java.io.Serializable, java.lang.Comparable<StringId>

public final class HierarchicalName
extends StringId

A HierarchicalName is an immutable encapsulation that consists of hierarchical name elements connected by an element separator where the left-most element represents the top-most hierarchy level.

The name elements are heavily restricted by a regular expression to guarantee the usability of this class in many different situations. They must consist of letters and numbers only (starting with a letter).

The StringId.toString()-method returns a full representation of a HierarchicalName which is compatible with the constructor. So this StringId.toString() -method is usable in business-logic and not only for debugging purposes.

An instance of HierarchicalName can be used in several threads concurrently.

Author:

agz

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ELEMENT_REGEX	The regular expression of the name elements.
static char	ELEMENT_SEPARATOR	The character that separates the name elements.

Constructor Summary

Constructors

Constructor	Description
HierarchicalName(java.lang.String name)	Creates a hierarchical name based on its representation (as StringId.toString() would return).

Method Summary

Modifier and Type	Method	Description
HierarchicalName	add(HierarchicalName hierarchicalName)	Returns a new HierarchicalName that contains the name elements of this HierarchicalName first, followed by the name elements of the specified HierarchicalName.
HierarchicalName	add(java.lang.String name)	Returns a new HierarchicalName that contains the name elements of this HierarchicalName first, followed by the name elements of the specified string representation.
boolean	endsWith(HierarchicalName hierarchicalName)	Returns whether this HierarchicalName ends with the specified HierarchicalName.
int	getCountElements()	Returns the count of name elements in this HierarchicalName.
HierarchicalName	getPrefix(int elementPosition)	Returns a prefix, i.e a HierarchicalName that contains the name elements of this HierarchicalName in the range of [0, the specified element position).
HierarchicalName	getSuffix(int elementPosition)	Returns a suffix, i.e a HierarchicalName that contains the name elements of this HierarchicalName in the range of [the specified element position, getCountElements()).
boolean	startsWith(HierarchicalName hierarchicalName)	Returns whether this HierarchicalName starts with the specified HierarchicalName.
HierarchicalName	subtractPrefix(HierarchicalName hierarchicalName)	Returns a suffix of this HierarchicalName by subtracting the specified prefix.
HierarchicalName	subtractSuffix(HierarchicalName hierarchicalName)	Returns a prefix of this HierarchicalName by subtracting the specified suffix.

Methods inherited from class com.saperion.common.lang.id.StringId

compareTo, equals, getString, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ELEMENT_SEPARATOR

public static final char ELEMENT_SEPARATOR

The character that separates the name elements.

See Also:

Constant Field Values

ELEMENT_REGEX

public static final java.lang.String ELEMENT_REGEX

The regular expression of the name elements.

See Also:

Constant Field Values

Constructor Detail

HierarchicalName

public HierarchicalName(java.lang.String name)

Creates a hierarchical name based on its representation (as StringId.toString() would return).

The specified name must not be null or empty.

Every contained name element must not violate the element name regular expression.

Parameters:

name - string-representation to create the HierarchicalName from

Method Detail

getCountElements

public int getCountElements()

Returns the count of name elements in this HierarchicalName.

Returns:

the count of name elements in this HierarchicalName

add

public HierarchicalName add(java.lang.String name)

Returns a new HierarchicalName that contains the name elements of this HierarchicalName first, followed by the name elements of the specified string representation.

The specified name must not be null or empty.

Every contained name element must not violate the element name regular expression.

Parameters:

name - string-representation of name elements to add

Returns:

new HierarchicalName that contains the name elements of this HierarchicalName first, followed by the name elements of the specified string representation

add

public HierarchicalName add(HierarchicalName hierarchicalName)

Returns a new HierarchicalName that contains the name elements of this HierarchicalName first, followed by the name elements of the specified HierarchicalName.

The specified HierarchicalName must not be null.

Parameters:

hierarchicalName - HierarchicalName to add

Returns:

new HierarchicalName that contains the name elements of this HierarchicalName first, followed by the name elements of the specified HierarchicalName

getPrefix

public HierarchicalName getPrefix(int elementPosition)

Returns a prefix, i.e a HierarchicalName that contains the name elements of this HierarchicalName in the range of [0, the specified element position).

The specified element position must be in the range [1, getCountElements()]

Parameters:

elementPosition - end position of the prefix to return

Returns:

prefix that contains the name elements of this HierarchicalName in the range of [0, the specified element position)

subtractSuffix

public HierarchicalName subtractSuffix(HierarchicalName hierarchicalName)

Returns a prefix of this HierarchicalName by subtracting the specified suffix.

The specified HierarchicalName must not be null.

This HierarchicalName must end with the specified HierarchicalName.

There must be a remaining prefix, i.e. this HierarchicalName must not equal the specified HierarchicalName.

Parameters:

hierarchicalName - suffix to subtract

Returns:

a prefix of this HierarchicalName by subtracting the specified suffix

getSuffix

public HierarchicalName getSuffix(int elementPosition)

Returns a suffix, i.e a HierarchicalName that contains the name elements of this HierarchicalName in the range of [the specified element position, getCountElements()).

The specified element position must be in the range [0, getCountElements() - 1]

Parameters:

elementPosition - start position of the suffix to return

Returns:

suffix that contains the name elements of this HierarchicalName in the range of [the specified element position, getCountElements())

subtractPrefix

public HierarchicalName subtractPrefix(HierarchicalName hierarchicalName)

Returns a suffix of this HierarchicalName by subtracting the specified prefix.

The specified HierarchicalName must not be null.

This HierarchicalName must start with the specified HierarchicalName.

There must be a remaining suffix, i.e. this HierarchicalName must not equal the specified HierarchicalName.

Parameters:

hierarchicalName - prefix to subtract

Returns:

a suffix of this HierarchicalName by subtracting the specified prefix

startsWith

public boolean startsWith(HierarchicalName hierarchicalName)

Returns whether this HierarchicalName starts with the specified HierarchicalName.

The specified HierarchicalName must not be null.

Parameters:

hierarchicalName - prefix to test

Returns:

whether this HierarchicalName starts with the specified HierarchicalName

endsWith

public boolean endsWith(HierarchicalName hierarchicalName)

Returns whether this HierarchicalName ends with the specified HierarchicalName.

The specified HierarchicalName must not be null.

Parameters:

hierarchicalName - suffix to test

Returns:

whether this HierarchicalName ends with the specified HierarchicalName