org.licas.ai_solver.util

Class NameHandler

java.lang.Object

org.licas.ai_solver.util.NameHandler

public class NameHandler
extends java.lang.Object

This class can perform some general operations for creating or parsing solution names. The names are assumed to have been created from the following format: 'source/name plus underscore plus index', for example: 'data1_1' would represent a generic type called 'data1' and an index or part number of '1' of this, for any number of instances (data1_1, data1_2, data1_3, etc). When two names are combined to produce a new one, the '+' or concatenation symbol is used between the names. For example, to create a new solution that is made from 'data1_1' and 'data2_3' would produce the new solution name of 'data1_1+data2_3'.

Constructor Summary

Constructors

Constructor and Description
NameHandler()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	checkforName(java.lang.Object nameObj) Check if the object has a name element and return if it does.
static java.lang.String	createSolutionName(java.lang.String name1, java.lang.String name2, java.util.ArrayList<java.lang.String> namesList) Create a new unique name for a solution based on existing names.
static java.lang.String	getNameSource(java.lang.String wholeName) Get the name source from the whole name.
static java.util.ArrayList<java.lang.String>	parseCompoundName(java.lang.String compoundName) Parse the compound solution name to separate the different solutions that it was created from.
static void	removeDuplicateNames(java.util.ArrayList<java.lang.String> namesList) Remove any duplicate names in the list.

Methods inherited from class java.lang.Object

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

Constructor Detail

NameHandler

public NameHandler()

Method Detail

checkforName

public static java.lang.String checkforName(java.lang.Object nameObj)

Check if the object has a name element and return if it does.

Parameters:

nameObj - an object that might contain a name field.

Returns:

the object name field if it is recognised.

createSolutionName

public static java.lang.String createSolutionName(java.lang.String name1,
                                                  java.lang.String name2,
                                                  java.util.ArrayList<java.lang.String> namesList)

Create a new unique name for a solution based on existing names. This is used by updateSolutions, when mutated solutions are created from two parent ones.

Parameters:

name1 - the first name to base the new name on.

name2 - the second name to base the new name on.

namesList - the list of existing names.

Returns:

a new name that is not already stored in the list.

getNameSource

public static java.lang.String getNameSource(java.lang.String wholeName)

Get the name source from the whole name. The whole name includes an index or part values, for example, 'name1_2' has the source 'name1' and the index value '2'. If there is no underscore separator, then the whole name is returned.

Parameters:

wholeName - the whole name to parse.

Returns:

the source value. This method would return the value 'name1'.

parseCompoundName

public static java.util.ArrayList<java.lang.String> parseCompoundName(java.lang.String compoundName)

Parse the compound solution name to separate the different solutions that it was created from.

Parameters:

compoundName - the name to parse.

Returns:

a string-based list of the solutions it was created from.

removeDuplicateNames

public static void removeDuplicateNames(java.util.ArrayList<java.lang.String> namesList)

Remove any duplicate names in the list.

Parameters:

namesList - the list of all names.