raccoon.tibco.tibrv.badhnati.descriptors
Class PrefixElement

java.lang.Object
  raccoon.tibco.tibrv.badhnati.descriptors.PrefixElement

public class PrefixElement
extends java.lang.Object

Contains the list of elements defined in a TIB/Rendezvous prefix field.

Since:

Raccoon v0.5. Created Oct 31, 2002 at 6:48:34 PM

Version:

$Id: PrefixElement.java,v 1.3 2003/07/01 19:19:56 crouvrais Exp $

Author:

Cedric ROUVRAIS

Constructor Summary

PrefixElement()
Default constructor, required for dynamic instanciation.

PrefixElement(java.lang.String pRadix, java.lang.String pPackageName, java.lang.Integer pIndex)
Convenience constructor used for assigning all the relevant elements to this instance.

Method Summary

java.lang.Integer	getIndex() The position of this class within the prefix list of the Active Enterprise message
java.lang.String	getPackage() The package name associated to this instance, doesn't contain the class name.
java.lang.String	getRadix() The root directory under which this element is located.
void	setIndex(java.lang.Integer pIndex) The position of this class within the prefix list of the Active Enterprise message
void	setPackage(java.lang.String pPackageName) Assigns the package name to this instance.
void	setRadix(java.lang.String pRadix) Assigns the root directory within the TIB/Repository of this element
void	setRepoGenerator(IRepoGenerator pRepoGenerator) Defines the utility component in relation with the TIB/Repository.
void	setRepoPath(java.lang.String pTibRepoPath) Used when handling a prefix element from a received TibrvMsg

Methods inherited from class java.lang.Object

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

Constructor Detail

PrefixElement

public PrefixElement()

Default constructor, required for dynamic instanciation.

PrefixElement

public PrefixElement(java.lang.String pRadix,
                     java.lang.String pPackageName,
                     java.lang.Integer pIndex)

Convenience constructor used for assigning all the relevant elements to this instance.

Parameters:

pRadix - the common directory where the definitions of the Active Enterprise elements are stored.

pPackageName - the fully qualified java package name without the class name

pIndex - the index of this elements within the prefix list of the TibrvMsg

Method Detail

setRepoGenerator

public void setRepoGenerator(IRepoGenerator pRepoGenerator)

Defines the utility component in relation with the TIB/Repository.

Parameters:

pRepoGenerator - the repository generator instance.

getPackage

public java.lang.String getPackage()

The package name associated to this instance, doesn't contain the class name.

Returns:

the fully qualified java package name.

setPackage

public void setPackage(java.lang.String pPackageName)

Assigns the package name to this instance.

The following operations are undertaken:

1. All '/' are replaced by '.'
2. If the packageName starts with '.', the '.' is removed
3. If the packageName ends with '.', the '.' is removed

Parameters:

pPackageName - the fully qualified java package name.

getIndex

public java.lang.Integer getIndex()

The position of this class within the prefix list of the Active Enterprise message

Returns:

the index of this class defined by Message

setIndex

public void setIndex(java.lang.Integer pIndex)

The position of this class within the prefix list of the Active Enterprise message

Parameters:

pIndex - the index of this class defined by Message

getRadix

public java.lang.String getRadix()

The root directory under which this element is located.

Returns:

the class directory, usually is AeConstants.CLASS_DIRECTORY

setRadix

public void setRadix(java.lang.String pRadix)

Assigns the root directory within the TIB/Repository of this element

Parameters:

pRadix - the root element in the form of a String (e.g. "/tibco/public/class/ae/")

setRepoPath

public void setRepoPath(java.lang.String pTibRepoPath)
                 throws RaccoonException

Used when handling a prefix element from a received TibrvMsg

Parameters:

pTibRepoPath - the prefix element provided by the TibrvMsg

Throws:

RaccoonException - if the RepoGenerator assigned to this instance fails.