jberd

Class JBerdAlias

java.lang.Object

jberd.JBerdAlias

public class JBerdAlias
extends java.lang.Object

A JBerdAlias provides a mapping between a descriptive name (the alias) and a tag path and optionally provides an associated rendering (ie the default method for representing the data of the item) The aliases are read from an alias file and held in a JBerdAliasDB

Constructor Summary

Constructors

Constructor and Description
JBerdAlias(java.lang.String tagPath, java.lang.String alias, BERrendering rendering) Creates an alias given a tag path, an alias and a rendering

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAlias() Return the alias name for the alias
BERrendering	getRendering() Return the alias name for the alias
JBerdTagPath	getTagPath() Return the tag path of the alias

Methods inherited from class java.lang.Object

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

Constructor Detail

JBerdAlias

public JBerdAlias(java.lang.String tagPath,
                  java.lang.String alias,
                  BERrendering rendering)
           throws BERException

Creates an alias given a tag path, an alias and a rendering

Parameters:

tagPath - The tag path to be aliased

alias - The alias (ie descriptive name)

rendering - The default rendering

Throws:

BERException - in the case that the alias cannot be created

Method Detail

getTagPath

public JBerdTagPath getTagPath()

Return the tag path of the alias

Returns:

the tag path described by the alias

getAlias

public java.lang.String getAlias()

Return the alias name for the alias

Returns:

the alias (ie the descriptive name) associated with the tag path

getRendering

public BERrendering getRendering()

Return the alias name for the alias

Returns:

the rendering (ie the default data representation) associated with the tag path