ch.agent.crnickl.api

Class NamingPolicy

java.lang.Object

ch.agent.crnickl.api.NamingPolicy

public class NamingPolicy
extends Object

The NamingPolicy defines the syntax for naming chronicles and series. It also provides methods and constants useful for presenting various textual elements with a unified appearance.

Author:

Jean-Paul Vetterli

Field Summary

Fields

Modifier and Type	Field and Description
static String	DESCRIPTION_SEPARATOR The string used as separator when joining simple descriptions to form a full descritpion.
static String	LIST_SEPARATOR The string used as separator when joining elements of a list.
static String	NAME_SEPARATOR The string used as separator when joining simple names to form a full name.

Constructor Summary

Constructors

Constructor and Description
NamingPolicy() Construct a naming policy.

Method Summary

Modifier and Type	Method and Description
String[]	asStringArray(String name) Return an array of simple names obtained by splitting the input parameter.
String	checkSimpleName(String name, boolean canModify) Check the length of a simple name, optionally replace all illegal characters with underscores, and convert to lower case.
String	fullDescription(List<String> descriptions) Return the full description obtained by joining the elements of the argument with DESCRIPTION_SEPARATOR.
String	fullDescription(String... descriptions) Return the full description obtained by joining the arguments with DESCRIPTION_SEPARATOR.
String	fullName(List<String> names) Return the full name obtained by joining the elements of the argument with NAME_SEPARATOR.
String	fullName(String... names) Return the full name obtained by joining the arguments with NAME_SEPARATOR.
protected String	join(String separator, String... strings) Return a string with all the strings starting with the second parameter joined using the first parameter as the separator.
String	joinValueAndDescription(String value, String description) Return a string with the value and the description joined with DESCRIPTION_SEPARATOR.
String[]	split(String name) Return an array of length 2 with the parent name and the simple name of the input argument.
String[]	splitValueAndDescription(String valueAndDescription) Return an array with a value and a description obtained by splitting the input on DESCRIPTION_SEPARATOR.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAME_SEPARATOR

public static final String NAME_SEPARATOR

The string used as separator when joining simple names to form a full name.

See Also:

Constant Field Values

DESCRIPTION_SEPARATOR

public static final String DESCRIPTION_SEPARATOR

The string used as separator when joining simple descriptions to form a full descritpion.

See Also:

Constant Field Values

LIST_SEPARATOR

public static final String LIST_SEPARATOR

The string used as separator when joining elements of a list.

See Also:

Constant Field Values

Constructor Detail

NamingPolicy

public NamingPolicy()

Construct a naming policy.

Method Detail

split

public String[] split(String name)
               throws T2DBException

Return an array of length 2 with the parent name and the simple name of the input argument. When the argument is already a simple name, the first element of the result is null.

Parameters:

name - a full name

Returns:

an array containing a full name, or null, and the last simple name

Throws:

T2DBException

asStringArray

public String[] asStringArray(String name)
                       throws T2DBException

Return an array of simple names obtained by splitting the input parameter. The elements are split assuming they are separated with NAME_SEPARATORs.

Parameters:

name - a full name

Returns:

an array of simple names

Throws:

T2DBException

checkSimpleName

public String checkSimpleName(String name,
                              boolean canModify)
                       throws T2DBException

Check the length of a simple name, optionally replace all illegal characters with underscores, and convert to lower case. Legal characters are the 48 letters in the range A-Z and a-z, decimal digits, the underscore (_), and the hyphen (-).

Parameters:

name - a simple name

canModify - if true replace every illegal character with an underscore

Returns:

name with all illegal characters replaced with underscores and converted to lower case

Throws:

T2DBException

fullName

public String fullName(String... names)

Return the full name obtained by joining the arguments with NAME_SEPARATOR.

Parameters:

names - an array of simple names

Returns:

a full name

fullName

public String fullName(List<String> names)

Return the full name obtained by joining the elements of the argument with NAME_SEPARATOR.

Parameters:

names - a list of simple names

Returns:

a full name

fullDescription

public String fullDescription(String... descriptions)

Return the full description obtained by joining the arguments with DESCRIPTION_SEPARATOR.

Parameters:

descriptions - an array of simple descriptions

Returns:

a full description

fullDescription

public String fullDescription(List<String> descriptions)

Return the full description obtained by joining the elements of the argument with DESCRIPTION_SEPARATOR.

Parameters:

descriptions - a list of simple descriptions

Returns:

a full description

joinValueAndDescription

public String joinValueAndDescription(String value,
                                      String description)

Return a string with the value and the description joined with DESCRIPTION_SEPARATOR.

Parameters:

value - a value

description - a description

Returns:

the value and description joined using the official format

splitValueAndDescription

public String[] splitValueAndDescription(String valueAndDescription)

Return an array with a value and a description obtained by splitting the input on DESCRIPTION_SEPARATOR. If there is no description, the second element of the result is an empty string.

Parameters:

valueAndDescription - a string with a value and a description

Returns:

and array with the value and the description

join

protected String join(String separator,
                      String... strings)

Return a string with all the strings starting with the second parameter joined using the first parameter as the separator.

Parameters:

separator - a string

strings - an array of strings

Returns:

a string