eu.bandm.tscore.base

Class EntityCatalog<E extends Entity>

java.lang.Object

eu.bandm.tscore.base.EntityCatalog<E>

All Implemented Interfaces:

Translet.Parseable<E>

public class EntityCatalog<E extends Entity>
extends java.lang.Object
implements Translet.Parseable<E>

Contains collection of basic score entities used as parameter values, indexed and documented in a multi lingual way. Each Entity must be contained in one such EntityCatalog. The name and documentation of the catalog itself is also multi lingual.

This class also defines a pseudo language for symbolic, non-national representations.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	defaultLang
protected Catalog<E>	entityNames
protected MuLi	ownNames
static java.lang.String	symbolic Language code of a pseudo language, used ot indes symbolic, non-national representations.dot symbols like "." or "^" for staccato articulation are indexed by this language code, while the wording "staccato" would be indexed by "it", meaning "Italian".

Constructor Summary

Constructors

Constructor and Description
EntityCatalog(java.lang.Class<E> itemClass, java.lang.String defaultLang, MuLi ownNames)
EntityCatalog(java.lang.Class<E> itemClass, java.lang.String defaultLang, java.lang.String defaultLangOwnName)

Method Summary

Modifier and Type	Method and Description
void	addEntityName(E entity, java.lang.String lang, java.lang.String name) Put additional names for an entity, beyond those defined at creation.
void	addEntityNames(E entity, MuLi humanNames) Put additional names for an entity, beyond those defined at creation.
static boolean	doesNotOverrideSymbolic(MuLi muli) Checks whether the symbolic language is used in the MuLi argument.
void	dump(java.io.PrintStream ps) Uses Catalog.dump(PrintStream)
java.lang.String	getDefaultLanguage()
java.util.Set<E>	getEntities()
E	getEntity(java.lang.String name)
E	getEntity(java.lang.String lang, java.lang.String name)
java.lang.String	getName()
java.lang.String	getName(java.lang.String lang)
MuLi	getNames(E entity)
Translet.Parser<E>	getParser() Get a lexer which accepts the names of the entities in the default language.
Translet.Parser<E>	getParser(java.lang.String lang) Get a lexer which accepts the names of the entities in the given language and returns the possibly found Entity as its value.
void	setDefaultLanguage(java.lang.String l) Changes default language dynamically.

Methods inherited from class java.lang.Object

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

Field Detail

symbolic

public static final java.lang.String symbolic

Language code of a pseudo language, used ot indes symbolic, non-national representations.dot symbols like "." or "^" for staccato articulation are indexed by this language code, while the wording "staccato" would be indexed by "it", meaning "Italian".

See Also:

Constant Field Values

ownNames

protected MuLi ownNames

entityNames

protected Catalog<E extends Entity> entityNames

defaultLang

protected java.lang.String defaultLang

Constructor Detail

EntityCatalog

public EntityCatalog(java.lang.Class<E> itemClass,
                     java.lang.String defaultLang,
                     MuLi ownNames)

Parameters:

defaultLang - the language code used as default for all entities contained herein, and for name and doc of the catalog itself.

ownNames - the names of the catalog, possibly in more than one language.

EntityCatalog

public EntityCatalog(java.lang.Class<E> itemClass,
                     java.lang.String defaultLang,
                     java.lang.String defaultLangOwnName)

Method Detail

doesNotOverrideSymbolic

public static boolean doesNotOverrideSymbolic(MuLi muli)

Checks whether the symbolic language is used in the MuLi argument. Called in all cases where the symbolic representation is CALCULATED and may not be set by the user explicitly.

dump

public void dump(java.io.PrintStream ps)

Uses Catalog.dump(PrintStream)

getDefaultLanguage

public java.lang.String getDefaultLanguage()

Returns:

default language, see constructor doc.

setDefaultLanguage

public void setDefaultLanguage(java.lang.String l)

Changes default language dynamically. Currently there is NO CHECK whether the new value is sensible. FIXME?

getName

public java.lang.String getName()

Returns:

name of the catalog, in default language, "null" if no such present.

getName

public java.lang.String getName(java.lang.String lang)

Returns:

name of the catalog, in given language, "null" if no such present.

getEntity

public E getEntity(java.lang.String lang,
                   java.lang.String name)

Returns:

Entity with the given name in the in given language, "null" if no such present.

getEntity

public E getEntity(java.lang.String name)

Returns:

Entity with the given name in the catalog's default language, "null" if no such present.

getEntities

public java.util.Set<E> getEntities()

Returns:

all entities contained.

getNames

public MuLi getNames(E entity)

Returns:

all names of the given Entity.

addEntityNames

public void addEntityNames(E entity,
                           MuLi humanNames)

Put additional names for an entity, beyond those defined at creation.

addEntityName

public void addEntityName(E entity,
                          java.lang.String lang,
                          java.lang.String name)

Put additional names for an entity, beyond those defined at creation.

getParser

public Translet.Parser<E> getParser(java.lang.String lang)

Get a lexer which accepts the names of the entities in the given language and returns the possibly found Entity as its value. Recurs to eu.bandm.tools.ulex.ULex.ConstMap, see there for the behaviour in case of failure.

Specified by:

getParser in interface Translet.Parseable<E extends Entity>

getParser

public Translet.Parser<E> getParser()

Get a lexer which accepts the names of the entities in the default language.

Specified by:

getParser in interface Translet.Parseable<E extends Entity>