com.endeca.content.assembler
Class ContentContext

java.lang.Object
  com.endeca.content.assembler.ContentContext

public class ContentContext
extends java.lang.Object

Describes the context within which some content assembler operation is occurring.

Since:

2.1.0

Version:

2.1.0

See Also:

ContentAssembler.assemble(ContentContext, ContentResource), ContentAssembler.evaluate(ContentContext, org.w3c.dom.Element), TagHandler.evaluate(ContentContext, org.w3c.dom.Element)

Constructor Summary

ContentContext(ContentAssembler pContentAssembler, ContentResourceLocator pContentResourceLocator)
Constructs a ContentContext with the given assembler and resource locator.

Method Summary

ContentAssembler	getContentAssembler() Returns the content assembler being used.
java.util.Stack	getContentItemStack() Returns the stack of ContentItems which are currently being created.
ContentResourceLocator	getContentResourceLocator() Returns the resource locator being used.
java.util.Map	getContentResources() Returns a map from the identifiers of the ContentResources which are currently being assembled to the partially-assembled resources themselves.
java.util.Stack	getContentResourceStack() Returns the stack of the ContentResources which are currently being assembled.
java.lang.String	getLocalPropertyName() Returns the name of the nearest ancestor property
void	setLocalPropertyName(java.lang.String pLocalPropertyName) Sets the name of the nearest ancestor property

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentContext

public ContentContext(ContentAssembler pContentAssembler,
                      ContentResourceLocator pContentResourceLocator)
               throws ContentException

Constructs a ContentContext with the given assembler and resource locator.

Parameters:

pContentAssembler - The content assembler being used

pContentResourceLocator - The resource locator being used

Throws:

ContentException - If an unrecoverable error occurs while attempting to construct this context.

Method Detail

getContentAssembler

public ContentAssembler getContentAssembler()

Returns the content assembler being used.

Returns:

The content assembler being used.

getContentResourceLocator

public ContentResourceLocator getContentResourceLocator()

Returns the resource locator being used.

Returns:

The resource locator being used.

getLocalPropertyName

public java.lang.String getLocalPropertyName()

Returns the name of the nearest ancestor property

Returns:

The name of the nearest ancestor property.

setLocalPropertyName

public void setLocalPropertyName(java.lang.String pLocalPropertyName)

Sets the name of the nearest ancestor property

Parameters:

pLocalPropertyName - The name of the nearest ancestor property

getContentResources

public java.util.Map getContentResources()

Returns a map from the identifiers of the ContentResources which are currently being assembled to the partially-assembled resources themselves.

Returns:

The map of content resources.

See Also:

ContentResource.getIdentifier()

getContentResourceStack

public java.util.Stack getContentResourceStack()

Returns the stack of the ContentResources which are currently being assembled. The resource upon which assembly has most recently begun will be at the top of the stack.

Returns:

The stack of content resources.

getContentItemStack

public java.util.Stack getContentItemStack()

Returns the stack of ContentItems which are currently being created. The content item upon which assembly has most recently begun will be at the top of the stack.

Returns:

The stack of content items.