Java Doc for TemplateService.java in » Web-Framework » TURBINE » org » apache » turbine » services » template » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Web Framework » TURBINE » org.apache.turbine.services.template

Source Cross Reference Class Diagram Java Document (Java Doc)

org.apache.turbine.services.template .TemplateService

All known Subclasses:   org.apache.turbine.services.template .TurbineTemplateService,
TemplateService
public interface TemplateService extends Service(Code)
This service provides a method for mapping templates to their appropriate Screens or Navigations. It also allows templates to define a layout/navigations/screen modularization within the template structure. It also performs caching if turned on in the properties file.
author:
   John D. McNally
author:
   Jason van Zyl
author:
   Daniel Rall
author:
   Ilkka Priha
version:
   $Id: TemplateService.java 534527 2007-05-02 16:10:59Z tv $

Field Summary
String DEFAULT_EXTENSION_KEY
     Default Extension for the template names.
String DEFAULT_EXTENSION_VALUE

String DEFAULT_NAME

String DEFAULT_TEMPLATE_KEY
     Default Template Name.
String DEFAULT_TEMPLATE_VALUE

char EXTENSION_SEPARATOR

final static String SERVICE_NAME
     The key under which this service is stored in TurbineServices.
char TEMPLATE_PARTS_SEPARATOR


Method Summary
String getDefaultExtension()
     Get the default template name extension specified in the template service properties.
String getDefaultLayout()
     Get the default layout module name of the template engine service corresponding to the default template name extension.
String getDefaultLayoutName(String template)
     Get the default layout module name of the template engine service corresponding to the template name extension of the named template.
Parameters:
  template - The template name.
String getDefaultLayoutName(RunData data)
     Find the default layout module name for the given request.
Parameters:
  data - The encapsulation of the request to retrieve thedefault layout for.
String getDefaultLayoutTemplate()
     Get the default layout template name of the template engine service corresponding to the default template name extension.
String getDefaultLayoutTemplateName(String template)
     Get the default layout template name of the template engine service corresponding to the template name extension of the named template.
Parameters:
  template - The template name.
String getDefaultNavigation()
     Get the default navigation module name of the template engine service corresponding to the default template name extension.
String getDefaultNavigationName(String template)
     Get the default navigation module name of the template engine service corresponding to the template name extension of the named template.
Parameters:
  template - The template name.
String getDefaultPage()
     Get the default page module name of the template engine service corresponding to the default template name extension.
String getDefaultPageName(String template)
     Get the default page module name of the template engine service corresponding to the template name extension of the named template.
Parameters:
  template - The template name.
String getDefaultPageName(RunData data)
     Find the default page module name for the given request.
Parameters:
  data - The encapsulation of the request to retrieve thedefault page for.
String getDefaultScreen()
     Get the default screen module name of the template engine service corresponding to the default template name extension.
String getDefaultScreenName(String template)
     Get the default screen module name of the template engine service corresponding to the template name extension of the named template.
Parameters:
  template - The template name.
String getDefaultTemplate()
     Returns the Default Template Name with the Default Extension.
String getExtension(String template)

String getLayoutName(String template)
     Locate and return the name of the layout module to be used with the named layout template.
Parameters:
  template - The layout template name.
String getLayoutTemplateName(String template)
     Locate and return the name of the layout template corresponding to the given screen template name parameter.
Parameters:
  template - The template name parameter.
String getNavigationName(String name)
     Locate and return the name of the navigation module to be used with the named navigation template.
Parameters:
  template - The navigation template name.
String getNavigationTemplateName(String template)
     Locate and return the name of the navigation template corresponding to the given template name parameter.
Parameters:
  template - The template name parameter.
String getScreenName(String template)
     Locate and return the name of the screen module to be used with the named screen template.
Parameters:
  template - The screen template name.
String getScreenTemplateName(String template)
     Locate and return the name of the screen template corresponding to the given template name parameter.
Parameters:
  template - The template name parameter.
TemplateEngineService getTemplateEngineService(String template)
     The org.apache.turbine.services.template.TemplateEngineService associated with the specified template's file extension.
Parameters:
  template - The template name.
boolean isCaching()

void registerTemplateEngineService(TemplateEngineService service)
     Registers the provided template engine for use by the TemplateService.
boolean templateExists(String template, String[] templatePaths)
     Delegates to the appropriate org.apache.turbine.services.template.TemplateEngineService to check the existance of the specified template.
String[] translateTemplatePaths(String[] templatePaths)
     Translates the supplied template paths into their Turbine-canonical equivalent (probably absolute paths).
Parameters:
  templatePaths - An array of template paths.

Field Detail
DEFAULT_EXTENSION_KEY
String DEFAULT_EXTENSION_KEY(Code)
Default Extension for the template names.

DEFAULT_EXTENSION_VALUE
String DEFAULT_EXTENSION_VALUE(Code)
Default value of the Turbine Module Caching

DEFAULT_NAME
String DEFAULT_NAME(Code)
"Default" name for Classes and Templates

DEFAULT_TEMPLATE_KEY
String DEFAULT_TEMPLATE_KEY(Code)
Default Template Name.

DEFAULT_TEMPLATE_VALUE
String DEFAULT_TEMPLATE_VALUE(Code)
Default value for the Template Name

EXTENSION_SEPARATOR
char EXTENSION_SEPARATOR(Code)
Character that separates a Template Name from the Extension

SERVICE_NAME
final static String SERVICE_NAME(Code)
The key under which this service is stored in TurbineServices.

TEMPLATE_PARTS_SEPARATOR
char TEMPLATE_PARTS_SEPARATOR(Code)
Character that separates the various Template Parts

Method Detail
getDefaultExtension
String getDefaultExtension()(Code)
Get the default template name extension specified in the template service properties. The default the extension.

getDefaultLayout
String getDefaultLayout()(Code)
Get the default layout module name of the template engine service corresponding to the default template name extension. The default layout module name.

getDefaultLayoutName
String getDefaultLayoutName(String template)(Code)
Get the default layout module name of the template engine service corresponding to the template name extension of the named template.
Parameters:
  template - The template name. The default layout module name.

getDefaultLayoutName
String getDefaultLayoutName(RunData data)(Code)
Find the default layout module name for the given request.
Parameters:
  data - The encapsulation of the request to retrieve thedefault layout for. The default layout module name.

getDefaultLayoutTemplate
String getDefaultLayoutTemplate()(Code)
Get the default layout template name of the template engine service corresponding to the default template name extension. The default layout template name.

getDefaultLayoutTemplateName
String getDefaultLayoutTemplateName(String template)(Code)
Get the default layout template name of the template engine service corresponding to the template name extension of the named template.
Parameters:
  template - The template name. The default layout template name.

getDefaultNavigation
String getDefaultNavigation()(Code)
Get the default navigation module name of the template engine service corresponding to the default template name extension. The default navigation module name.

getDefaultNavigationName
String getDefaultNavigationName(String template)(Code)
Get the default navigation module name of the template engine service corresponding to the template name extension of the named template.
Parameters:
  template - The template name. The default navigation module name.

getDefaultPage
String getDefaultPage()(Code)
Get the default page module name of the template engine service corresponding to the default template name extension. The default page module name.

getDefaultPageName
String getDefaultPageName(String template)(Code)
Get the default page module name of the template engine service corresponding to the template name extension of the named template.
Parameters:
  template - The template name. The default page module name.

getDefaultPageName
String getDefaultPageName(RunData data)(Code)
Find the default page module name for the given request.
Parameters:
  data - The encapsulation of the request to retrieve thedefault page for. The default page module name.

getDefaultScreen
String getDefaultScreen()(Code)
Get the default screen module name of the template engine service corresponding to the default template name extension. The default screen module name.

getDefaultScreenName
String getDefaultScreenName(String template)(Code)
Get the default screen module name of the template engine service corresponding to the template name extension of the named template.
Parameters:
  template - The template name. The default screen module name.

getDefaultTemplate
String getDefaultTemplate()(Code)
Returns the Default Template Name with the Default Extension. If the extension is unset, return only the template name The default template Name

getExtension
String getExtension(String template)(Code)
Return Extension for a supplied template
Parameters:
  template - The template name extension The extension for the supplied template

getLayoutName
String getLayoutName(String template) throws Exception(Code)
Locate and return the name of the layout module to be used with the named layout template.
Parameters:
  template - The layout template name. The found layout module name.
exception:
  Exception - , a generic exception.

getLayoutTemplateName
String getLayoutTemplateName(String template) throws Exception(Code)
Locate and return the name of the layout template corresponding to the given screen template name parameter.
Parameters:
  template - The template name parameter. The found screen template name.
exception:
  Exception - , a generic exception.

getNavigationName
String getNavigationName(String name) throws Exception(Code)
Locate and return the name of the navigation module to be used with the named navigation template.
Parameters:
  template - The navigation template name. The found navigation module name.
exception:
  Exception - , a generic exception.

getNavigationTemplateName
String getNavigationTemplateName(String template) throws Exception(Code)
Locate and return the name of the navigation template corresponding to the given template name parameter.
Parameters:
  template - The template name parameter. The found navigation template name.
exception:
  Exception - , a generic exception.

getScreenName
String getScreenName(String template) throws Exception(Code)
Locate and return the name of the screen module to be used with the named screen template.
Parameters:
  template - The screen template name. The found screen module name.
exception:
  Exception - , a generic exception.

getScreenTemplateName
String getScreenTemplateName(String template) throws Exception(Code)
Locate and return the name of the screen template corresponding to the given template name parameter.
Parameters:
  template - The template name parameter. The found screen template name.
exception:
  Exception - , a generic exception.

getTemplateEngineService
TemplateEngineService getTemplateEngineService(String template)(Code)
The org.apache.turbine.services.template.TemplateEngineService associated with the specified template's file extension.
Parameters:
  template - The template name. The template engine service.

isCaching
boolean isCaching()(Code)
Returns true if the Template Service has caching activated true if Caching is active.

registerTemplateEngineService
void registerTemplateEngineService(TemplateEngineService service)(Code)
Registers the provided template engine for use by the TemplateService.
Parameters:
  service - The TemplateEngineService to register.

templateExists
boolean templateExists(String template, String[] templatePaths)(Code)
Delegates to the appropriate org.apache.turbine.services.template.TemplateEngineService to check the existance of the specified template.
Parameters:
  template - The template to check for the existance of.
Parameters:
  templatePaths - The paths to check for the template.

translateTemplatePaths
String[] translateTemplatePaths(String[] templatePaths)(Code)
Translates the supplied template paths into their Turbine-canonical equivalent (probably absolute paths).
Parameters:
  templatePaths - An array of template paths. An array of translated template paths.

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.