jberd

Class JBerdAliasDB

java.lang.Object

jberd.JBerdAliasDB

public class JBerdAliasDB
extends java.lang.Object

An object containing a set of aliases. This enables a set of tag paths to be associated with aliases (descriptive names) and renderings (default data representations) The DB may be queried to obtain an alias either by alias name or by tagpath. Both must be unique within the DB.

Constructor Summary

Constructors

Constructor and Description
JBerdAliasDB(java.lang.String inFile) Create an alias DB from an input file

Method Summary

Modifier and Type	Method and Description
JBerdAlias	getByAlias(java.lang.String alias) Query the db by providing an alias name, returning an alias with the associated details
JBerdAlias	getByTagPath(java.lang.String tagPath) Query the db by providing a tag path, returning an alias with the associated details

Methods inherited from class java.lang.Object

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

Constructor Detail

JBerdAliasDB

public JBerdAliasDB(java.lang.String inFile)
             throws BERException

Create an alias DB from an input file

Parameters:

inFile - A CSV file containing alias information. Field 1 must contain the tagpath, field 2 the alias and field 3 the rendering (optional - defaults to NATIVE)

Throws:

BERException - in the case of error, details are in the msg

Method Detail

getByAlias

public final JBerdAlias getByAlias(java.lang.String alias)

Query the db by providing an alias name, returning an alias with the associated details

Parameters:

alias - The alias name

Returns:

the associated Alias which will provide alias name, tagpath and optionally rendering

getByTagPath

public final JBerdAlias getByTagPath(java.lang.String tagPath)

Query the db by providing a tag path, returning an alias with the associated details

Parameters:

tagPath - the aliased tagpath

Returns:

the associated Alias which will provide alias name, tagpath and optionally rendering