com.plumtree.portaluiinfrastructure.tags.manager
Interface ITagLibManager

All Known Implementing Classes:

TagLibManager

public interface ITagLibManager

Method Summary

XPHashtable	GetLibraries() Return a data structure holding name and version number of all libraries loaded.
XPArrayList	GetLibraryTagList(java.lang.String _sLibname, double _dVersion) Return tag info for a specific library TODO this may not be the form we really want to return this data in that's still being figured out - CVN
XPArrayList	GetLibraryTags(java.lang.String _sLibname, double _dVersion) Return all tags in library TODO this may not be the form we really want to return this data in that's still being figured out - CVN
int	GetNumCustomTagLibraries() This method returns the number of custom Tag Libraries currently loaded.
int	GetNumCustomTags() This method returns the number of custom Tags currently loaded.
ATag	GetTag(java.lang.String _strTagName, java.lang.String _strLibraryName) Create the requested Tag.
ATag	GetTag(java.lang.String _strTagName, java.lang.String _strLibraryName, double _dLibraryVersion) Create the requested Tag.
TagLibraryMetaData	GetTagLibMetadata(java.lang.String _sLibname, double _dVersion) Return library meta data on a specific library and version.
void	GetTagMetadata(java.lang.String _sLibname, double _dVersion, java.lang.String _sTagname) Return metadata or something on all tags in library TODO not yet implemented cvn
boolean	HasTag(java.lang.String _strTagName, java.lang.String _strLibraryName) Return true if the tag specified by the parameters exists otherwise return false.
boolean	HasTag(java.lang.String _strTagName, java.lang.String _strLibraryName, double _dLibraryVersion) Return true if the tag specified by the parameters exists otherwise return false.
void	LoadClasses(java.lang.String strLibDir, java.lang.String strConfigFile) This method initializes the TagLibManager and should only be called by the Application Warmup.
void	LoadCustomClasses(java.lang.String strLibDir, java.lang.String strConfigFile) This method initializes the TagLibManager with custom tags to overwrite the original ones and should only be called by the the Application Warmup.
void	ReloadAllTagLibraries() This method reloads both the standard and custom tag libraries from the config files.
void	ReloadTagLibrary(java.lang.String _sLibname, double _dVersion) This method reloads a particular version of a tag library from the same library file (i.e.

Method Detail

GetTag

ATag GetTag(java.lang.String _strTagName,
            java.lang.String _strLibraryName,
            double _dLibraryVersion)

Create the requested Tag. (Use this method where the library version is specified where possible as it is more efficient.) This method should not be called by developers. It is only for the Tag Framework.

Parameters:

String - _strTagName The name of the requested tag

String - _strLibraryName The name of the library that contains the requested tag

_dLibraryVersion - The version of the library that contains the requested tag

Returns:

ATag The requested tag, null on failure

GetTag

ATag GetTag(java.lang.String _strTagName,
            java.lang.String _strLibraryName)

Create the requested Tag. (Avoid this method where the library version is not specified where possible as it is less efficient.) This method should not be called by developers. It is only for the Tag Framework.

Parameters:

String - _strTagName The name of the requested tag

String - _strLibraryName The name of the library that contains the requested tag

Returns:

ATag The requested tag, null on failure

HasTag

boolean HasTag(java.lang.String _strTagName,
               java.lang.String _strLibraryName,
               double _dLibraryVersion)

Return true if the tag specified by the parameters exists otherwise return false. Use this method specifying the library version rather than not where possible as it is much more efficient.

Parameters:

String - _strTagName The name of the requested tag

String - _strLibraryName The name of the library that contains the requested tag

_dLibraryVersion - The version of the library that contains the requested tag

Returns:

true if the tag exists otherwise false.

HasTag

boolean HasTag(java.lang.String _strTagName,
               java.lang.String _strLibraryName)

Return true if the tag specified by the parameters exists otherwise return false. Use the method specifying the library version rather than this where possible as it is much more efficient.

Parameters:

String - _strTagName The name of the requested tag

String - _strLibraryName The name of the library that contains the requested tag

Returns:

true if the tag exists otherwise false.

LoadClasses

void LoadClasses(java.lang.String strLibDir,
                 java.lang.String strConfigFile)

This method initializes the TagLibManager and should only be called by the Application Warmup. This method can only be called once.

Parameters:

strLibDir - The file directory where jars and dlls can be found

strConfigFile - the name of the config file

LoadCustomClasses

void LoadCustomClasses(java.lang.String strLibDir,
                       java.lang.String strConfigFile)

This method initializes the TagLibManager with custom tags to overwrite the original ones and should only be called by the the Application Warmup.

Parameters:

strLibDir - The file directory where jars and dlls can be found

strConfigFile - the name of the custom config file

GetLibraries

XPHashtable GetLibraries()

Return a data structure holding name and version number of all libraries loaded. TODO this may not be the form we really want to return this data in that's still being figured out - CVN

GetTagLibMetadata

TagLibraryMetaData GetTagLibMetadata(java.lang.String _sLibname,
                                     double _dVersion)

Return library meta data on a specific library and version. TODO this may not be the form we really want to return this data in that's still being figured out - CVN

GetLibraryTagList

XPArrayList GetLibraryTagList(java.lang.String _sLibname,
                              double _dVersion)

Return tag info for a specific library TODO this may not be the form we really want to return this data in that's still being figured out - CVN

GetLibraryTags

XPArrayList GetLibraryTags(java.lang.String _sLibname,
                           double _dVersion)

Return all tags in library TODO this may not be the form we really want to return this data in that's still being figured out - CVN

GetTagMetadata

void GetTagMetadata(java.lang.String _sLibname,
                    double _dVersion,
                    java.lang.String _sTagname)

Return metadata or something on all tags in library TODO not yet implemented cvn

ReloadTagLibrary

void ReloadTagLibrary(java.lang.String _sLibname,
                      double _dVersion)

This method reloads a particular version of a tag library from the same library file (i.e. jar or dll) that it was originally loaded from.

Parameters:

_sLibname - String The name of the library to reload (not display name).

_dVersion - double The version number of the library to reload.

ReloadAllTagLibraries

void ReloadAllTagLibraries()

This method reloads both the standard and custom tag libraries from the config files.

GetNumCustomTagLibraries

int GetNumCustomTagLibraries()

This method returns the number of custom Tag Libraries currently loaded. This number is reset every time custom objects are loaded.

Returns:

The number of custom Tag Libraries currently loaded.

GetNumCustomTags

int GetNumCustomTags()

This method returns the number of custom Tags currently loaded. This number is reset every time custom objects are loaded.

Returns:

The number of custom Tagss currently loaded.