ca.uqac.lif.labpal

Class Namer

java.lang.Object

ca.uqac.lif.labpal.Namer

Direct Known Subclasses:

LatexNamer, TitleNamer

public abstract class Namer
extends java.lang.Object

Object that automatically builds a description for a table or plot object, based on the parameters that have been used to create it.

Since:

2.11

Author:

Sylvain Hallé

Constructor Summary

Constructors

Constructor and Description
Namer()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	buildName(Region r, java.lang.String prefix, java.lang.String suffix) Builds a name based on a region
protected java.lang.String	createFragment(java.lang.String dim_name, ca.uqac.lif.json.JsonElement json_value) Creates a fragment of a nickname based on a dimension and its associated value
protected abstract java.lang.String	createFragment(java.lang.String dim_name, java.lang.Number n) Creates a fragment of a nickname based on a dimension and its associated numerical value
protected abstract java.lang.String	createFragment(java.lang.String dim_name, java.lang.String s) Creates a fragment of a nickname based on a dimension and its associated string value
protected java.lang.String	handlePrefix(java.lang.String prefix) Applies a transformation to the prefix
protected java.lang.String	handleSuffix(java.lang.String suffix) Applies a transformation to the suffix
static java.lang.String	latexify(java.lang.String s) Replaces illegal characters in a LaTeX string by legal ones.
protected java.lang.String	postProcess(java.lang.String s) Performs a last post-processing of the name
void	setNickname(ca.uqac.lif.mtnp.plot.Plot p, Region r, java.lang.String prefix, java.lang.String suffix) Gives a nickname to a plot
void	setNickname(ca.uqac.lif.mtnp.table.Table t, Region r, java.lang.String prefix, java.lang.String suffix) Gives a nickname to a table
void	setTitle(ca.uqac.lif.mtnp.plot.Plot p, Region r, java.lang.String prefix, java.lang.String suffix) Gives a title to a plot
void	setTitle(ca.uqac.lif.mtnp.table.Table t, Region r, java.lang.String prefix, java.lang.String suffix) Gives a title to a table

Methods inherited from class java.lang.Object

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

Constructor Detail

Namer

public Namer()

Method Detail

setNickname

public void setNickname(ca.uqac.lif.mtnp.table.Table t,
                        Region r,
                        java.lang.String prefix,
                        java.lang.String suffix)

Gives a nickname to a table

Parameters:

t - The table to name

r - The region that describes the table

prefix - A prefix to append at the beginning of the name

suffix - A suffix to append at the end of the name

setTitle

public void setTitle(ca.uqac.lif.mtnp.table.Table t,
                     Region r,
                     java.lang.String prefix,
                     java.lang.String suffix)

Gives a title to a table

Parameters:

t - The table to name

r - The region that describes the table

prefix - A prefix to append at the beginning of the name

suffix - A suffix to append at the end of the name

setNickname

public void setNickname(ca.uqac.lif.mtnp.plot.Plot p,
                        Region r,
                        java.lang.String prefix,
                        java.lang.String suffix)

Gives a nickname to a plot

Parameters:

p - The plot to name

r - The region that describes the table

prefix - A prefix to append at the beginning of the name

suffix - A suffix to append at the end of the name

setTitle

public void setTitle(ca.uqac.lif.mtnp.plot.Plot p,
                     Region r,
                     java.lang.String prefix,
                     java.lang.String suffix)

Gives a title to a plot

Parameters:

p - The plot to name

r - The region that describes the table

prefix - A prefix to append at the beginning of the name

suffix - A suffix to append at the end of the name

latexify

public static java.lang.String latexify(java.lang.String s)

Replaces illegal characters in a LaTeX string by legal ones. Since identifiers in LaTeX commands can only have letters, numbers and other symbols must be replaced into something else to create a valid identifier. The basic replacement scheme is to change every occurrence of a digit into a unique letter that somehow "looks" like the digit.

Parameters:

s - The string to replace

Returns:

The replaced string

buildName

protected java.lang.String buildName(Region r,
                                     java.lang.String prefix,
                                     java.lang.String suffix)

Builds a name based on a region

Parameters:

r - The region that describes the object

prefix - A prefix to append at the beginning of the name

suffix - A suffix to append at the end of the name

Returns:

The name

createFragment

protected final java.lang.String createFragment(java.lang.String dim_name,
                                                ca.uqac.lif.json.JsonElement json_value)

Creates a fragment of a nickname based on a dimension and its associated value

Parameters:

dim_name - The name of the dimension

json_value - The value

Returns:

The name fragment

handlePrefix

protected java.lang.String handlePrefix(java.lang.String prefix)

Applies a transformation to the prefix

Parameters:

prefix - The prefix

Returns:

The transformed prefix

handleSuffix

protected java.lang.String handleSuffix(java.lang.String suffix)

Applies a transformation to the suffix

Parameters:

suffix - The suffix

Returns:

The transformed suffix

postProcess

protected java.lang.String postProcess(java.lang.String s)

Performs a last post-processing of the name

Parameters:

s - The string

Returns:

The post-processed string

createFragment

protected abstract java.lang.String createFragment(java.lang.String dim_name,
                                                   java.lang.Number n)

Creates a fragment of a nickname based on a dimension and its associated numerical value

Parameters:

dim_name - The name of the dimension

n - The numerical value

Returns:

The name fragment

createFragment

protected abstract java.lang.String createFragment(java.lang.String dim_name,
                                                   java.lang.String s)

Creates a fragment of a nickname based on a dimension and its associated string value

Parameters:

dim_name - The name of the dimension

s - The string value

Returns:

The name fragment