Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
Constructor and Description |
---|
ItemAndSpecifierStack() |
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 to getting your parent accessor.
|
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.
|
public int getAncestorCount()
public boolean isInDocument()
public RepositoryItem getNthAncestor(int pIndex)
public atg.repository.search.indexing.ItemAndSpecifier getNthAncestorItemAndSpecifier(int pIndex)
public RepositoryItem getParent()
public void pushParent(RepositoryItem pItem, atg.repository.search.indexing.specifier.OutputItemSpecifier pItemSpec)
public void pushParent(atg.repository.search.indexing.ItemAndSpecifier pItemAndSpec)
public atg.repository.search.indexing.ItemAndSpecifier popParent()
public RepositoryItem getAncestorItemOfType(java.lang.String pRepositoryItemTypeName) throws RepositoryException
pRepositoryItemTypeName
- - the type of item (item descriptor name) we're interested in.RepositoryException
public java.lang.String toString()
toString
in class java.lang.Object
public void copyFrom(ItemAndSpecifierStack pItemAndSpecifierStack)
pItemAndSpecifierStack
- the object from which to copy.public void clearParents()