formatter.java

High performance DB query

/*
 * @(#)$Id: Formatter.java,v 1.5 2004/07/02 23:59:21 huebsch Exp $
 *
 * Copyright (c) 2001-2004 Regents of the University of California.
 * All rights reserved.
 *
 * This file is distributed under the terms in the attached BERKELEY-LICENSE
 * file. If you do not find these files, copies can be found by writing to:
 * Computer Science Division, Database Group, Universite of California,
 * 617 Soda Hall #1776, Berkeley, CA 94720-1776. Attention: Berkeley License
 *
 * Copyright (c) 2003-2004 Intel Corporation. All rights reserved.
 *
 * This file is distributed under the terms in the attached INTEL-LICENSE file.
 * If you do not find these files, copies can be found by writing to:
 * Intel Research Berkeley, 2150 Shattuck Avenue, Suite 1300,
 * Berkeley, CA, 94704.  Attention:  Intel License Inquiry.
 */


package pier.helpers.formatters;

import java.net.InetSocketAddress;
import java.nio.ByteBuffer;
import pier.data.Tuple;
import pier.data.TupleCollection;
import pier.query.QueryPlan;
import pier.query.QueryTag;

/**
 * Interface Formatter
 *
 */
public interface Formatter {

    public static final int MESSAGE_TYPE_ALL = 1;
    public static final int MESSAGE_TYPE_QUERY_ECHO = 2;
    public static final int MESSAGE_TYPE_ERROR = 3;
    public static final int MESSAGE_TYPE_MESSAGE = 4;
    public static final int MESSAGE_TYPE_SCHEMA = 5;
    public static final int MESSAGE_TYPE_RESULT = 6;

    /**
     * Method formatTuple
     *
     * @param tuple
     * @param refnum
     * @param queryTag
     * @param source
     * @param time
     * @return
     */
    public ByteBuffer formatTuple(Tuple tuple, int refnum, QueryTag queryTag,
                                  InetSocketAddress source, long time);

    /**
     * Method formatTuples
     *
     * @param tuples
     * @param refnum
     * @param queryTag
     * @param source
     * @param time
     * @return
     */
    public ByteBuffer formatTuples(TupleCollection tuples, int refnum,
                                   QueryTag queryTag, InetSocketAddress source,
                                   long time);

    /**
     * Method formatQuery
     *
     * @param theQuery
     * @param refnum
     * @param source
     * @param time
     * @return
     */
    public ByteBuffer formatQuery(String theQuery, int refnum,
                                  InetSocketAddress source, long time);

    /**
     * Method formatQuery
     *
     * @param thePlan
     * @param refnum
     * @param source
     * @param time
     * @return
     */
    public ByteBuffer formatQuery(QueryPlan thePlan, int refnum,
                                  InetSocketAddress source, long time);

    /**
     * Method formatMessage
     *
     * @param message
     * @param refnum
     * @param queryTag
     * @param source
     * @param time
     * @return
     */
    public ByteBuffer formatMessage(String message, int refnum,
                                    QueryTag queryTag,
                                    InetSocketAddress source, long time);

    /**
     * Method formatError
     *
     * @param errorMessage
     * @param refnum
     * @param queryTag
     * @param source
     * @param time
     * @return
     */
    public ByteBuffer formatError(String errorMessage, int refnum,
                                  QueryTag queryTag, InetSocketAddress source,
                                  long time);

    /**
     * Method formatSchema
     *
     * @param tuple
     * @param refnum
     * @param queryTag
     * @param time
     * @return
     */
    public ByteBuffer formatSchema(Tuple tuple, int refnum, QueryTag queryTag,
                                   long time);

    /**
     * Method messagePreamble
     *
     *
     * @param messageType
     * @param time
     * @return
     */
    public ByteBuffer messagePreamble(int messageType, long time);

    /**
     * Method messagePostamble
     *
     *
     * @param messageType
     * @param time
     * @return
     */
    public ByteBuffer messagePostamble(int messageType, long time);
}