edu.isi.powerloom.gui.xmlobject
Class PLSurrogateContainer

java.lang.Object
  |
  +--edu.isi.powerloom.gui.xmlobject.PLSurrogateContainer

All Implemented Interfaces:

PLList, PLObject, PLTreeNode

public class PLSurrogateContainer

extends java.lang.Object

implements PLTreeNode, PLList, PLObject

Hold a collection of surrogates. Used for JTrees and JLists, also used by KnowledgeManager to cache groups of objects.

Since:

Wed Mar 13 17:37:57 2002

Author:

Eric Melz

Constructor Summary

PLSurrogateContainer()

PLSurrogateContainer(java.util.List surrogates)

PLSurrogateContainer(java.lang.String label, java.util.List surrogates)

Method Summary

void	addPLObject(PLObject object)
PLTreeNode	getChild(int index)
int	getChildCount()
PLSurrogateContainer	getChildSurrogates()
java.lang.Object	getElementAt(int i)
PLSurrogateContainer	getFilteredSurrogateContainer(java.lang.String prefix) Return a new container which contains items that have a given prefix
java.lang.String	getID() surrogate support
int	getIndexOfChild(PLTreeNode child)
java.lang.String	getModule()
int	getSize()
java.util.List	getSurrogates()
boolean	isLeaf()
boolean	isUndefined()
PLSurrogateContainer	listifyTreeContainer() Miscellaneous methods
PLSurrogateContainer	mergeSurrogateContainer(PLSurrogateContainer otherContainer)
int	removePLObject(PLObject object) Insert the method's description here.
void	setChild(int index, PLTreeNode child)
void	setChildSurrogates(PLSurrogateContainer container)
void	setLabel(java.lang.String label)
void	setSurrogates(java.util.List surrogates)
void	setUndefined(boolean flag)
static PLSurrogate	surrogatify(java.lang.Object object)
static java.util.List	surrogatifyList(java.util.List candidates)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PLSurrogateContainer

public PLSurrogateContainer()

PLSurrogateContainer

public PLSurrogateContainer(java.util.List surrogates)

PLSurrogateContainer

public PLSurrogateContainer(java.lang.String label,
                            java.util.List surrogates)

Method Detail

surrogatifyList

public static java.util.List surrogatifyList(java.util.List candidates)

getModule

public java.lang.String getModule()

Specified by:

getModule in interface PLObject

surrogatify

public static PLSurrogate surrogatify(java.lang.Object object)

setSurrogates

public void setSurrogates(java.util.List surrogates)

getSurrogates

public java.util.List getSurrogates()

setChild

public void setChild(int index,
                     PLTreeNode child)

Specified by:

setChild in interface PLTreeNode

getChild

public PLTreeNode getChild(int index)

Specified by:

getChild in interface PLTreeNode

getIndexOfChild

public int getIndexOfChild(PLTreeNode child)

Specified by:

getIndexOfChild in interface PLTreeNode

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface PLTreeNode

isLeaf

public boolean isLeaf()

Specified by:

isLeaf in interface PLTreeNode

getElementAt

public java.lang.Object getElementAt(int i)

Specified by:

getElementAt in interface PLList

getSize

public int getSize()

Specified by:

getSize in interface PLList

addPLObject

public void addPLObject(PLObject object)

Specified by:

addPLObject in interface PLList

setLabel

public void setLabel(java.lang.String label)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getID

public java.lang.String getID()

surrogate support

Specified by:

getID in interface PLObject

getChildSurrogates

public PLSurrogateContainer getChildSurrogates()

Specified by:

getChildSurrogates in interface PLObject

setChildSurrogates

public void setChildSurrogates(PLSurrogateContainer container)

Specified by:

setChildSurrogates in interface PLObject

listifyTreeContainer

public PLSurrogateContainer listifyTreeContainer()

Miscellaneous methods

removePLObject

public int removePLObject(PLObject object)

Insert the method's description here. Creation date: (4/12/2002 1:27:09 PM)

Specified by:

removePLObject in interface PLList

Parameters:

object - edu.isi.powerloom.gui.xmlobject.PLObject

Returns:

int

isUndefined

public boolean isUndefined()

Specified by:

isUndefined in interface PLObject

setUndefined

public void setUndefined(boolean flag)

Specified by:

setUndefined in interface PLObject

getFilteredSurrogateContainer

public PLSurrogateContainer getFilteredSurrogateContainer(java.lang.String prefix)

Return a new container which contains items that have a given prefix

mergeSurrogateContainer

public PLSurrogateContainer mergeSurrogateContainer(PLSurrogateContainer otherContainer)