atg.repository.search.indexing

Class ItemAndSpecifierStack

java.lang.Object

atg.repository.search.indexing.ItemAndSpecifierStack

Direct Known Subclasses:

Context

public class ItemAndSpecifierStack
extends java.lang.Object

A class that manages a stack of item and specifiers. Extended by Context.

Created: March 28 2005

See Also:

Context

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Constructor Summary

Constructors

Constructor and Description
ItemAndSpecifierStack()

Method Summary

Modifier and Type	Method and Description
void	clearParents() Clear the stack of parent items
void	copyFrom(ItemAndSpecifierStack pItemAndSpecifierStack) Copy from the specified item, setting our contents to be the same as its.
int	getAncestorCount() Return the number of parents/ancestors.
RepositoryItem	getAncestorItemOfType(java.lang.String pRepositoryItemTypeName) Get the ancestor of the specified repository item type (may return a subtype) Will search the parents beginning with the highest index and working back towards the beginning.
RepositoryItem	getNthAncestor(int pIndex) Return the Nth ancestor.
atg.repository.search.indexing.ItemAndSpecifier	getNthAncestorItemAndSpecifier(int pIndex) Return the Nth ancestor ItemAndSpecifier.
RepositoryItem	getParent() A convenience method for getting the current parent repository item.
atg.repository.search.indexing.specifier.OutputItemSpecifier	getParentSpecifier() A convenience method for getting the current parent OutputItemSpecifier.
boolean	isInDocument() Whether we are in a document.
atg.repository.search.indexing.ItemAndSpecifier	popParent() Pop off a parent.
void	pushParent(atg.repository.search.indexing.ItemAndSpecifier pItemAndSpec) Push a parent item.
void	pushParent(RepositoryItem pItem, atg.repository.search.indexing.specifier.OutputItemSpecifier pItemSpec) Push a parent item.
java.lang.String	toString() Add a debugging toString method.

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

ItemAndSpecifierStack

public ItemAndSpecifierStack()

Method Detail

getAncestorCount

public int getAncestorCount()

Return the number of parents/ancestors.

isInDocument

public boolean isInDocument()

Whether we are in a document.

getNthAncestor

public RepositoryItem getNthAncestor(int pIndex)

Return the Nth ancestor. The zeroth ancestor is the ancestor at the base of the stack.

getNthAncestorItemAndSpecifier

public atg.repository.search.indexing.ItemAndSpecifier getNthAncestorItemAndSpecifier(int pIndex)

Return the Nth ancestor ItemAndSpecifier. The zeroth ancestor is the ancestor at the base of the stack.

getParent

public RepositoryItem getParent()

A convenience method for getting the current parent repository item.

getParentSpecifier

public atg.repository.search.indexing.specifier.OutputItemSpecifier getParentSpecifier()

A convenience method for getting the current parent OutputItemSpecifier. .

pushParent

public void pushParent(RepositoryItem pItem,
                       atg.repository.search.indexing.specifier.OutputItemSpecifier pItemSpec)

Push a parent item.

pushParent

public void pushParent(atg.repository.search.indexing.ItemAndSpecifier pItemAndSpec)

Push a parent item.

popParent

public atg.repository.search.indexing.ItemAndSpecifier popParent()

Pop off a parent.

getAncestorItemOfType

public RepositoryItem getAncestorItemOfType(java.lang.String pRepositoryItemTypeName)
                                     throws RepositoryException

Get the ancestor of the specified repository item type (may return a subtype) Will search the parents beginning with the highest index and working back towards the beginning.

Parameters:

pRepositoryItemTypeName - - the type of item (item descriptor name) we're interested in.

Returns:

the first ancestor repository item of type pRepositoryItemTypeName. Returns null if no item was found.

Throws:

RepositoryException

toString

public java.lang.String toString()

Add a debugging toString method.

Overrides:

toString in class java.lang.Object

copyFrom

public void copyFrom(ItemAndSpecifierStack pItemAndSpecifierStack)

Copy from the specified item, setting our contents to be the same as its.

Parameters:

pItemAndSpecifierStack - the object from which to copy.

clearParents

public void clearParents()

Clear the stack of parent items