Java Doc for ContentTool.java in » Web-Framework » TURBINE » org » apache » turbine » services » pull » tools » 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.pull.tools

Source Cross Reference

Class Diagram

Java Document (Java Doc)

java.lang .Object

org.apache.turbine.services.pull.tools .ContentTool

ContentTool

public class ContentTool implements ApplicationTool(Code)

Terribly simple tool to translate URIs into Turbine Links. Equivalent to URIUtils.getAbsoluteLink() in a pull tool.

If you're missing any routines from the 'old' $content tool concerning path_info or query data, you did use the wrong tool then. You should've used the TemplateLink tool which should be available as "$link" in your context.

This is an application pull tool for the template system. You should not use it in a normal application!
author:
Henning P. Schmiedehausen
version:
$Id: ContentTool.java 534527 2007-05-02 16:10:59Z tv $

Field Summary
final public static boolean	CONTENT_TOOL_ENCODING_DEFAULT
final public static String	CONTENT_TOOL_ENCODING_KEY Should this tool add Container Encoding to the URIs returned? True might cause trouble e.g.
final public static String	CONTENT_TOOL_PREFIX
final public static boolean	CONTENT_TOOL_RELATIVE_DEFAULT
final public static String	CONTENT_TOOL_RELATIVE_KEY Should this tool return relative URIs or absolute? Default: Absolute.
boolean	wantEncoding
boolean	wantRelative

Constructor Summary
public	ContentTool()

Method Summary
public String	getAbsoluteURI(String path) Returns the Turbine URI of a given Path.
public String	getRelativeURI(String path) Returns the Turbine URI of a given Path.
public String	getURI(String path)
public void	init(Object data) This will initialise a ContentTool object that was constructed with the default constructor (ApplicationTool method).
public void	refresh()

Field Detail

CONTENT_TOOL_ENCODING_DEFAULT
final public static boolean CONTENT_TOOL_ENCODING_DEFAULT(Code)
	Default Value for CONTENT_TOOL_ENCODING_KEY

CONTENT_TOOL_ENCODING_KEY
final public static String CONTENT_TOOL_ENCODING_KEY(Code)
	Should this tool add Container Encoding to the URIs returned? True might cause trouble e.g. if you run with Apache HTTP Daemon / Tomcat Combo. Default is false (like Turbine 2.2)

CONTENT_TOOL_PREFIX
final public static String CONTENT_TOOL_PREFIX(Code)
	Prefix for Parameters for this tool

CONTENT_TOOL_RELATIVE_DEFAULT
final public static boolean CONTENT_TOOL_RELATIVE_DEFAULT(Code)
	Default Value for CONTENT_TOOL_RELATIVE_KEY

CONTENT_TOOL_RELATIVE_KEY
final public static String CONTENT_TOOL_RELATIVE_KEY(Code)
	Should this tool return relative URIs or absolute? Default: Absolute.

wantEncoding
boolean wantEncoding(Code)
	Do we want the container to encode the response?

wantRelative
boolean wantRelative(Code)
	Do we want a relative link?

Constructor Detail

ContentTool
public ContentTool()(Code)
	C'tor

Method Detail

getAbsoluteURI
public String getAbsoluteURI(String path)(Code)
	Returns the Turbine URI of a given Path. The result is always an absolute path starting with the server scheme (http/https). Parameters: path - The path to translate Turbine translated absolute path

getRelativeURI
public String getRelativeURI(String path)(Code)
	Returns the Turbine URI of a given Path. The result is always relative to the context of the application. Parameters: path - The path to translate Turbine translated absolute path

getURI
public String getURI(String path)(Code)
	Returns the Turbine URI of a given Path Parameters: path - The path to translate Turbine translated absolute path

init
public void init(Object data)(Code)
	This will initialise a ContentTool object that was constructed with the default constructor (ApplicationTool method). Parameters: data - assumed to be a RunData object

refresh
public void refresh()(Code)
	Refresh method - does nothing

Methods inherited from java.lang.Object

native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.