All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class key.Container

java.lang.Object
   |
   +----key.Atom
           |
           +----key.Container

public class Container

extends Atom

implements Parent, Referrer

addToAction

is allowed to add objects to this container

assumedContents

concealInAction

can conceal atoms in this container

constrainedType

countContents

limitProperty

reference

referenceProperty

removeFromAction

is allowed to remove objects from this container

revealInAction

can reveal atoms in this container

sortAction

can sort atoms in this container

staticActions

Container()

Container(boolean)

add(Atom)

Adds the supplied atom and sets its parent to this

add(Tag)

Doesn't do a lot of the checking a 'traditional' add does - container limits, constrained types - none of these are checked.

addInternal(Atom)

Internal routine so overloading add()'s don't get confused

addTopLevel(Container)

Adds all the symbols in this container to the provided Container This container retains a reference to its elements, but full ownership (the elements parents) is given to the new container.

alias(Atom)

argument(String)

The argument to a container is the class to constrain contained objects to

contains(Atom)

containsAction(Action)

Returns true if the action is supported by this class.

count()

delete(Atom)

dispose()

This is a method that should be called only once.

elements()

This function returns Tags?

evalReadOnlyProperty(ReadOnlyProperty)

override to return the correct value for the supplied property make sure you call super.evalReadOnlyProperty if you don't understand it before returning null

finalize()

fullResolve()

Ensures that all the sub-objects of this component have been resolved as well.

getAction(String)

Returns the action corresponding to the supplied name.

getActions()

Returns a list of the actions supported by this class.

getConstraint()

getElement(String)

getElementAt(int)

getExactElement(String)

getParentId()

see Parent.java

getSymbol(String)

Full search for the symbol of id s.

getSymbol(StringTokenizer, boolean)

Returns the symbol specified by the tokenizer.
This function requires that it is passed a stringtokenizer containing elements like:

• /
• sym
• .
  getTagElement(String)
  getTotalContainers()
  getTrieFor(String)
  isReference()
  limit(int)
  loadFrom(DataInput)
  noLongerReferencing(Atom)
  see Parent.java
  noSideEffectRemove(Atom)
  partialLoad()
  readContents(DataInput)
  rekey(Atom, AliasListKey)
  Used primarily in the 'Many' command.
  remove(Atom)
  removes the atom.
  removeByNumber(int)
  removeInternal(Atom)
  resolve()
  This completely overrides super.resolve(), which is called from fullResolve() when that happens.
  setConstraint(Type)
  sort()
  swapout()
  Similar to dispose(), the swapout() method prepares a Atom to be swapped out non-destructively You should probably sync() before doing this...
  swapout(Atom)
  tagElements()
  unalias(Atom)
  writeContents(DataOutput)
  writeTo(DataOutput)

 protected boolean reference

 protected ReadOnlyProperty referenceProperty

 protected ReadOnlyProperty countContents

 protected DataProperty limitProperty

 protected Type constrainedType

 protected boolean assumedContents

 protected static StringKeyCollection staticActions

 public static Action addToAction

is allowed to add objects to this container

 public static Action removeFromAction

is allowed to remove objects from this container

 public static Action concealInAction

can conceal atoms in this container

 public static Action revealInAction

can reveal atoms in this container

 public static Action sortAction

can sort atoms in this container

 public Container()

 public Container(boolean ref)

 public void partialLoad()

Overrides:

partialLoad in class Atom

 public void argument(String args) throws IllegalArgumentException

The argument to a container is the class to constrain contained objects to

Overrides:

argument in class Atom

 public Type getConstraint()

 protected void setConstraint(Type c)

 public final boolean isReference()

 protected void add(Tag t) throws BadKeyException, NonUniqueKeyException

Doesn't do a lot of the checking a 'traditional' add does - container limits, constrained types - none of these are checked. Also, recursive joins (more than one) aren't supported here. If thats the little tidbit of information you're looking for, then I bet you had to search ;p~

 protected void addInternal(Atom added) throws BadKeyException, NonUniqueKeyException

Internal routine so overloading add()'s don't get confused

Parameters:

full - true if you want a full link, if false, only partial link

 public void add(Atom added) throws BadKeyException, NonUniqueKeyException

Adds the supplied atom and sets its parent to this

 public void alias(Atom toAlias)

 public void unalias(Atom toNormal)

 public void rekey(Atom toRekey,
                   AliasListKey newAlk)

Used primarily in the 'Many' command.

 public final void sort()

 public void remove(Atom removed) throws NonUniqueKeyException, NoSuchElementException, BadKeyException

removes the atom. if this is its parent container, specifies that the atom should be disposed of (deleted)

 protected void removeInternal(Atom removed) throws NonUniqueKeyException, NoSuchElementException, BadKeyException

 protected void noSideEffectRemove(Atom removed) throws NonUniqueKeyException, NoSuchElementException, BadKeyException

 public void swapout(Atom a)

 public void delete(Atom a)

 public void removeByNumber(int c) throws NonUniqueKeyException, BadKeyException

 public final Symbol getElementAt(int n)

 public void limit(int amount)

 public final Object getTrieFor(String m)

 public void addTopLevel(Container addTo)

Adds all the symbols in this container to the provided Container This container retains a reference to its elements, but full ownership (the elements parents) is given to the new container. (ie, the parents of all elements in this container are passed to the parent container)

 public final Enumeration elements()

This function returns Tags?

 public final Enumeration tagElements()

 public void swapout()

Similar to dispose(), the swapout() method prepares a Atom to be swapped out non-destructively You should probably sync() before doing this...

Overrides:

swapout in class Atom

 public void dispose()

This is a method that should be called only once.

Overrides:

dispose in class Atom

 public void loadFrom(DataInput from) throws IOException

Overrides:

loadFrom in class Atom

 public void resolve()

This completely overrides super.resolve(), which is called from fullResolve() when that happens.

Overrides:

resolve in class Atom

 public void fullResolve()

Ensures that all the sub-objects of this component have been resolved as well.

Overrides:

fullResolve in class Atom

 protected void readContents(DataInput from) throws IOException

 public void writeTo(DataOutput to) throws IOException

Overrides:

writeTo in class Atom

 protected void writeContents(DataOutput to) throws IOException

 public final int count()

 public Object getSymbol(String s)

Full search for the symbol of id s.

Overrides:

getSymbol in class Atom

 public Object evalReadOnlyProperty(ReadOnlyProperty p)

override to return the correct value for the supplied property make sure you call super.evalReadOnlyProperty if you don't understand it before returning null

Overrides:

evalReadOnlyProperty in class Atom

 protected Object getSymbol(StringTokenizer st,
                            boolean resolveTags)

Returns the symbol specified by the tokenizer.
This function requires that it is passed a stringtokenizer containing elements like:

• /
• sym
• .
• anotherSym

if the tokenizer doesn't start with a . it is assumed (but only one)

Returns:

atom, a property, or null, or a Trie if a Trie is returned, it will contain tags, not the actual atoms

Overrides:

getSymbol in class Atom

 public final Object getTagElement(String s)

 public final Object getElement(String s)

 public final Object getExactElement(String s)

 public String getParentId()

see Parent.java

 public void noLongerReferencing(Atom a)

see Parent.java

 public final boolean contains(Atom a)

 public Enumeration getActions()

Returns a list of the actions supported by this class.

Overrides:

getActions in class Atom

 public boolean containsAction(Action a)

Returns true if the action is supported by this class.

Overrides:

containsAction in class Atom

 public Action getAction(String name)

Returns the action corresponding to the supplied name. This routine will need to be overriden by sub-classes using actions.

Overrides:

getAction in class Atom

 public static int getTotalContainers()

 protected void finalize() throws Throwable

Overrides:

finalize in class Atom

All Packages  Class Hierarchy  This Package  Previous  Next  Index