Package com.tailf.ncs.template

Class Template

Object

com.tailf.ncs.template.Template

public class Template
extends Object

Template represents an NCS template, that is a template loaded from the directory templates of the package.

Constructor Summary

Constructors

Constructor	Description
Template(ServiceContext aServiceContext, String aTemplateName)	Construct a Template.
Template(Maapi aMaapi, String aTemplateName)
Template(NavuContext aContext, String aTemplateName)

Method Summary

Modifier and Type	Method	Description
void	apply(Maapi maapi, int tid, ConfPath rootPath, TemplateVariables variables)	Apply a template in the specified context
void	apply(NavuNode root, TemplateVariables variables)	Apply a template in the specified context
static boolean	exists(ServiceContext context, String template)	Tests for existence of a template.
static boolean	exists(Maapi maapi, String template)
static boolean	exists(NavuContext context, String template)
static Set<String>	getTemplates(ServiceContext aServiceContext)	Returns a set consisting of the loaded templates.
static Set<String>	getTemplates(Maapi maapi)
static Set<String>	getTemplates(NavuContext context)
String[]	getVariables()

Methods inherited from class java.lang.Object

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

Constructor Details

Template

public Template(ServiceContext aServiceContext,
 String aTemplateName)
         throws ConfException

Construct a Template. Note that the template has to have already been loaded by NCS, otherwise an exception is thrown.

Parameters:

aServiceContext - the context is which this call is made.

aTemplateName - name of the template.

Throws:

ConfException

Template

public Template(NavuContext aContext,
 String aTemplateName)
         throws ConfException

Throws:

ConfException

Template

public Template(Maapi aMaapi,
 String aTemplateName)
         throws ConfException

Throws:

ConfException

Method Details

getTemplates

public static Set<String> getTemplates(ServiceContext aServiceContext)
                                throws ConfException

Returns a set consisting of the loaded templates.

Parameters:

aServiceContext - the context in which this call is made.

Returns:

Set of loaded templates.

Throws:

ConfException

getTemplates

public static Set<String> getTemplates(NavuContext context)
                                throws ConfException

Throws:

ConfException

getTemplates

public static Set<String> getTemplates(Maapi maapi)
                                throws ConfException

Throws:

ConfException

getVariables

public String[] getVariables()
                      throws ConfException

Throws:

ConfException

exists

public static boolean exists(ServiceContext context,
 String template)
                      throws ConfException

Tests for existence of a template.

Parameters:

context - the context in which this call is made.

template - name of the template.

Returns:

true or false depending on whether the template is loaded or not.

Throws:

ConfException

exists

public static boolean exists(NavuContext context,
 String template)
                      throws ConfException

Throws:

ConfException

exists

public static boolean exists(Maapi maapi,
 String template)
                      throws ConfException

Throws:

ConfException

apply

public void apply(NavuNode root,
 TemplateVariables variables)
           throws ConfException

Apply a template in the specified context

Parameters:

root - the initial context and root context for evaluation of XPath expressions

variables - a set of key value pairs where each key will be an XPath variable.

Throws:

ConfException

apply

public void apply(Maapi maapi,
 int tid,
 ConfPath rootPath,
 TemplateVariables variables)
           throws ConfException

Apply a template in the specified context

Parameters:

maapi - a maapi connection to the NCS server

tid - a transaction id which should be attached to the maapi connection

rootPath - the initial context and root context for evaluation of XPath expressions

variables - a set of key value pairs where each key will be an XPath variable.

Throws:

ConfException