com.tridion.tcdl

Class OutputDocument

java.lang.Object

com.tridion.tcdl.OutputDocument

public class OutputDocument
extends Object

Provides dependency lists identified by name and maintains 'bookmarks' that mark the position where such dependency lists should be injected in the final body. Each dependency list is identified by a name, For example, a list of unique imports or a list of unique variable declarations etc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OutputDocument.Bookmark Container for bookmark information.

Constructor Summary

Constructors

Constructor and Description
OutputDocument()

Method Summary

Modifier and Type	Method and Description
void	addDependency(String section, String value) Adds a dependency to a dependency list identified by [section] without checking if the dependency already exists.
boolean	ensureBookmark(String identifier, int position, boolean requiresCodeBlock) Make sure a bookmark for the [identifier] exists.
void	ensureDependency(String section, String value) Makes sure a dependency ([value]) exists in a dependency list identified by [section].
String	getBody() Returns the body as it was produced by the tag handlers.
OutputDocument.Bookmark	getBookmark(String identifier) Returns the bookmark for the given identifier.
List	getBookmarks() Gives an ordered list of Bookmark objects.
List	getDependencies(String section) Returns the list of dependencies identified by [section].
protected Collection	getDependencySections() All unique sections currently present.
void	removeDependency(String section, String value) Removes an existing dependency.
void	setBookmark(String identifier, boolean requiresCodeBlock) Marks the current position using an identifier.
protected void	updateBookmarks(int offsetAmount, boolean topLevel) Updates all (if any) currently still relative bookmark positions.
protected void	write(String data) Use by the framework to write the body data after tag processing is completed.
protected void	writeDocumentTo(OutputStream target) For debug purposes only.

Methods inherited from class java.lang.Object

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

Constructor Detail

OutputDocument

public OutputDocument()

Method Detail

addDependency

public void addDependency(String section,
                          String value)

Adds a dependency to a dependency list identified by [section] without checking if the dependency already exists.

Parameters:

section - identifier for the list you want to add the value to

value - value to add to the dependency list

ensureDependency

public void ensureDependency(String section,
                             String value)

Makes sure a dependency ([value]) exists in a dependency list identified by [section]. If the dependency does not yet exist it is added.

Parameters:

section - identifier for the list you want to add the value to

value - value to add to the dependency list

removeDependency

public void removeDependency(String section,
                             String value)

Removes an existing dependency.

Parameters:

section - identifier for the list you want to remove the value from

value - value that is to be removed

getDependencies

public List getDependencies(String section)

Returns the list of dependencies identified by [section].

A dependency list is a collection of (unique) statements, for example a list of imports for a jsp/.net page

Parameters:

section - identifier for the list you want to retrieve

Returns:

list of dependencies to return

getDependencySections

protected Collection getDependencySections()

All unique sections currently present.

Returns:

All unique sections currently present

write

protected void write(String data)

Use by the framework to write the body data after tag processing is completed.

Parameters:

data - string data to append to the body.

getBody

public String getBody()

Returns the body as it was produced by the tag handlers. Note that the body is only available after processing of the source document is complete.

Returns:

the current body

setBookmark

public void setBookmark(String identifier,
                        boolean requiresCodeBlock)

Marks the current position using an identifier.

This position will be relative at first and resolved to an absolute position while processing the tcdl data. It is absolute once the tag and its parent tags are closed (and only then)

Parameters:

identifier - the identifier

getBookmark

public OutputDocument.Bookmark getBookmark(String identifier)

Returns the bookmark for the given identifier.

Note that the position of a bookmark is only known after all parent tags in which the bookmark is done have finished processing (e.g. after their closing tag).

Parameters:

identifier - the identifier

Returns:

the bookmark for the identifier or null if it does not exist

ensureBookmark

public boolean ensureBookmark(String identifier,
                              int position,
                              boolean requiresCodeBlock)

Make sure a bookmark for the [identifier] exists. If it does not exists, it is added with the given position. Note that this works on the finalized (absolute positioned) bookmarks. So effectively this method can only be used after processing of the tcdl content is complete (e.g. in the construction phase of building the output document only)

Parameters:

identifier - the identifier

position - the position

requiresCodeBlock - boolean indicating code block is required

Returns:

boolean

getBookmarks

public List getBookmarks()

Gives an ordered list of Bookmark objects. Ordered occurs on their position and if positions are equal by creation order

Returns:

an ordered list of Bookmark objects

updateBookmarks

protected void updateBookmarks(int offsetAmount,
                               boolean topLevel)

Updates all (if any) currently still relative bookmark positions. When a bookmark tag occurs inside other tags the final (absolute) position can only be determined when the parent tags are closed (e.g. when updated with topLevel=true)

Parameters:

offsetAmount - the offset amount

topLevel - boolean indicating top level

writeDocumentTo

protected void writeDocumentTo(OutputStream target)
                        throws IOException

For debug purposes only.

Parameters:

target - the output stream

Throws:

IOException