BaseListTransport.java

/*

   BaseListTransport.java

   This class is intended to provide a serializable object that
   can be used to bulk-dump a static description of the object
   types on the server to the client.

   Created: 2 March 1998

   Module By: Jonathan Abbey, jonabbey@arlut.utexas.edu

   -----------------------------------------------------------------------

   Ganymede Directory Management System

   Copyright (C) 1996-2013
   The University of Texas at Austin

   Ganymede is a registered trademark of The University of Texas at Austin

   Contact information

   Web site: http://www.arlut.utexas.edu/gash2
   Author Email: ganymede_author@arlut.utexas.edu
   Email mailing list: ganymede@arlut.utexas.edu

   US Mail:

   Computer Science Division
   Applied Research Laboratories
   The University of Texas at Austin
   PO Box 8029, Austin TX 78713-8029

   Telephone: (512) 835-3200

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.

*/

package arlut.csd.ganymede.common;

import arlut.csd.ganymede.rmi.Base;

import java.util.Vector;

/*------------------------------------------------------------------------------
                                                                           class
                                                               BaseListTransport

------------------------------------------------------------------------------*/

/**
 * <p>This class is intended to provide a serializable object that can
 * be used to bulk-dump a static description of the category and base
 * structures on the server to the client.</p>
 */

public class BaseListTransport implements java.io.Serializable {

  static final long serialVersionUID = -8386494641226607100L;

  // ---

  private StringBuffer buffer;
  private transient int lastIndex = 0;

  /* -- */

  public BaseListTransport()
  {
  }

  /**
   *
   * Client side accessor
   *
   */

  public Vector<Base> getBaseList()
  {
    String token;
    BaseDump baseChild;
    char[] src;
    Vector<Base> results = new Vector<Base>();

    /* -- */

    src = buffer.toString().toCharArray();
    lastIndex = 0;

    while (lastIndex < src.length)
      {
        token = getChunk(src, lastIndex);

        if (!token.equals("base"))
          {
            throw new RuntimeException("buffer format exception");
          }

        baseChild = new BaseDump(this, src, lastIndex);
        lastIndex = baseChild.getLastIndex();
        results.add(baseChild);
      }

    return results;
  }

  // ***
  //
  // construction methods, server side
  //
  // ***

  /**
   * <p>This method is provided so that server-side code can add chunks of data for serialization.
   * In the BaseListTransport case, the
   * {@link arlut.csd.ganymede.server.DBObjectBase#addBaseToTransport(arlut.csd.ganymede.common.BaseListTransport,arlut.csd.ganymede.server.GanymedeSession)}
   * method is responsible for calling addChunk to build
   * 'this' up for serialization.</p>
   */

  public void addChunk(String text)
  {
    char[] chars;

    /* -- */

    //    System.err.println("Server adding chunk " + label + ":" + operand);

    if (buffer == null)
      {
        buffer = new StringBuffer();
      }

    // add our label

    if (text != null)
      {
        chars = text.toCharArray();
      }
    else
      {
        buffer.append("|");
        return;
      }

    for (int j = 0; j < chars.length; j++)
      {
        if (chars[j] == '|')
          {
            buffer.append("\\|");
          }
        else if (chars[j] == '\\')
          {
            buffer.append("\\\\");
          }
        else
          {
            buffer.append(chars[j]);
          }
      }

    buffer.append("|");
  }

  // ***
  //
  // private methods
  //
  // ***

  private String getChunk(char[] chars, int startDex)
  {
    StringBuilder result = new StringBuilder();

    /* -- */

    for (lastIndex = startDex; lastIndex < chars.length; lastIndex++)
      {
        if (chars[lastIndex] == '|')
          {
            lastIndex++;
            return result.toString();
          }
        else if (chars[lastIndex] == '\\')
          {
            result.append(chars[++lastIndex]);
          }
        else
          {
            result.append(chars[lastIndex]);
          }
      }

    throw new RuntimeException("Ran out of chunk data: " + result.toString());
  }
}