Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> RuntimeCollective >> [ webapps overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

com.RuntimeCollective.webapps
Class BeanSequence  

java.lang.Object
  java.util.AbstractMap
      java.util.TreeMap
          com.RuntimeCollective.webapps.BeanSequence

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map, java.io.Serializable, java.util.SortedMap

---

public class BeanSequence

extends java.util.TreeMap

A wrapper for a synchronised SortedMap of SequenceBeans which includes extra methods for maintaining sequence numbers to avoid conflicts.

A bean sequence is a set of beans, ordered by their 'sequence' properties. If a bean is added to a bean sequence, then subsequent beans will have their sequences incremented to avoid conflicts; and if a bean is removed then subsequent beans will have their sequences decremented to avoid gaps. Changes to the bean sequence will be saved to the database (using the beans save() and delete() methods) to ensure that the sequence properties remain synchronized.

Sequences are of the form (int)(char) where (int) is an optional positive integer and (char) is a optional single character. (For example 0,1,2,3,3a,3b,... )

Notes

• Only the extra methods that this sub-class of TreeMap makes available are synchronized. All the methods inherited directly from TreeMap are not.
• This class extends Map, and so each member of the sequence will have both a key and a value. Therefore when using the struts custom tag to iterate over a bean sequence, the properties of the constituent beans (rather than the keys) should be accessed using property="value.propertyname". See the tag documentation for more details.

  Version:

  $Id: BeanSequence.java,v 1.5 2003/09/30 15:13:03 joe Exp $

  ---

  Nested Class Summary

   

  Nested classes inherited from class java.util.TreeMap

   

  Nested classes inherited from class java.util.AbstractMap

   

  Nested classes inherited from class java.util.Map

  java.util.Map.Entry

   

  Field Summary
  private  java.util.SortedMap	beans           The internal map of beans.
  private static java.lang.String	SEQUENCE

   

  Fields inherited from class java.util.TreeMap

   

  Fields inherited from class java.util.AbstractMap

   

  Constructor Summary

  BeanSequence()           Default construtor.

   

  Method Summary
  void	add(com.RuntimeCollective.webapps.bean.SequenceBean bean)           Add a bean to this map, keyed by its current sequence.
  com.RuntimeCollective.webapps.bean.SequenceBean	append(com.RuntimeCollective.webapps.bean.SequenceBean bean)           Append this bean to the end of the map, setting its sequence accordingly, and saving the bean.
  private  void	decBean(com.RuntimeCollective.webapps.bean.SequenceBean bean)           Recursively decrement the sequence of all beans starting at this one.
  com.RuntimeCollective.webapps.bean.SequenceBean	getBean(java.lang.String sequence)           Get a bean of this map, by sequence.
  private  void	incBean(com.RuntimeCollective.webapps.bean.SequenceBean bean)           Recursively increment the sequence of beans starting at this one.
  com.RuntimeCollective.webapps.bean.SequenceBean	last()           Return the last bean in the map, or null if the sequence is empty.
  java.lang.String	lastSequence()           Get the sequence of the last bean in the map, or "" if the set is empty.
  void	move(com.RuntimeCollective.webapps.bean.SequenceBean bean)           Move a bean to a new sequence position.
  private static java.lang.String	nextSequence(com.RuntimeCollective.webapps.bean.SequenceBean bean)
  private static java.lang.String	nextSequence(java.lang.String sequence)           Get the next sequence after this one.
  private static java.lang.String	prevSequence(com.RuntimeCollective.webapps.bean.SequenceBean bean)
  private static java.lang.String	prevSequence(java.lang.String sequence)           Get the prev sequence for this bean.
  void	remove(com.RuntimeCollective.webapps.bean.SequenceBean bean)           Remove a bean from this map.
  java.lang.String	toString()           Returns a String representation of this map.
  static boolean	validSequence(java.lang.String sequence)           Check whether the sequence number of this bean is valid.

   

  Methods inherited from class java.util.TreeMap

  clear, clone, comparator, containsKey, containsValue, entrySet, firstKey, get, headMap, keySet, lastKey, put, putAll, remove, size, subMap, tailMap, values

   

  Methods inherited from class java.util.AbstractMap

  equals, hashCode, isEmpty

   

  Methods inherited from class java.lang.Object

  finalize, getClass, notify, notifyAll, wait, wait, wait

   

  Methods inherited from interface java.util.Map

  equals, hashCode, isEmpty

   

  Field Detail

  SEQUENCE

  private static final java.lang.String SEQUENCE

  See Also:

  Constant Field Values

  ---

  beans

  private java.util.SortedMap beans

  The internal map of beans.

  Constructor Detail

  BeanSequence

  public BeanSequence()

  Default construtor.

  Method Detail

  getBean

  public com.RuntimeCollective.webapps.bean.SequenceBean getBean(java.lang.String sequence)

  Get a bean of this map, by sequence.

  ---

  remove

  public void remove(com.RuntimeCollective.webapps.bean.SequenceBean bean)
              throws java.sql.SQLException

  Remove a bean from this map. This will set the sequence number of the removed bean to a dummy value (="@"+oldsequence), and decrement the sequence number of any subsequent beans.

  The .save() method will be called on any bean whose sequence number is changed as a result of this operation (including the bean removed).

  ---

  decBean

  private void decBean(com.RuntimeCollective.webapps.bean.SequenceBean bean)
                throws java.sql.SQLException

  Recursively decrement the sequence of all beans starting at this one.

  ---

  add

  public void add(com.RuntimeCollective.webapps.bean.SequenceBean bean)
           throws java.sql.SQLException

  Add a bean to this map, keyed by its current sequence. If a bean already exists with this sequence number, then all beans with a higher sequence number are incremented by one as necessary.

  The .save() method will be called on any bean in the map whose sequence number is changed as a result of this operation (but not the added bean).

  ---

  incBean

  private void incBean(com.RuntimeCollective.webapps.bean.SequenceBean bean)
                throws java.sql.SQLException

  Recursively increment the sequence of beans starting at this one.

  ---

  move

  public void move(com.RuntimeCollective.webapps.bean.SequenceBean bean)
            throws java.sql.SQLException

  Move a bean to a new sequence position. The save() method will be called on this bean, and any beans changed as a result of this operation. If the bean is not yet in the sequence then it will be added.

  ---

  lastSequence

  public java.lang.String lastSequence()

  Get the sequence of the last bean in the map, or "" if the set is empty.

  ---

  nextSequence

  private static java.lang.String nextSequence(com.RuntimeCollective.webapps.bean.SequenceBean bean)

  ---

  nextSequence

  private static java.lang.String nextSequence(java.lang.String sequence)

  Get the next sequence after this one.

  ---

  prevSequence

  private static java.lang.String prevSequence(com.RuntimeCollective.webapps.bean.SequenceBean bean)

  ---

  prevSequence

  private static java.lang.String prevSequence(java.lang.String sequence)

  Get the prev sequence for this bean.

  ---

  append

  public com.RuntimeCollective.webapps.bean.SequenceBean append(com.RuntimeCollective.webapps.bean.SequenceBean bean)
                                                         throws java.sql.SQLException

  Append this bean to the end of the map, setting its sequence accordingly, and saving the bean.

  ---

  last

  public com.RuntimeCollective.webapps.bean.SequenceBean last()

  Return the last bean in the map, or null if the sequence is empty.

  ---

  validSequence

  public static boolean validSequence(java.lang.String sequence)

  Check whether the sequence number of this bean is valid. I.e. whether the sequence is of the form (int)(char) where (int) is an optional positivr integer and (char) is a optional single character. (For example 0,1,2,3,3a,3b,... ).

  ---

  toString

  public java.lang.String toString()

  Description copied from class: java.util.AbstractMap

  Returns a String representation of this map. This is a listing of the map entries (which are specified in Map.Entry as being getKey() + "=" + getValue()), separated by a comma and space (", "), and surrounded by braces ('{' and '}'). This implementation uses a StringBuffer and iterates over the entrySet to build the String. Note that this can fail with an exception if underlying keys or values complete abruptly in toString().

  ---

  Overview  Package   Class  Use  Deprecated  Index
  Home >> All >> com >> RuntimeCollective >> [ webapps overview ]	PREV CLASS  NEXT CLASS
  SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

  ---