Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> derby >> impl >> sql >> [ execute overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.apache.derby.impl.sql.execute
Class AggregatorInfo  

java.lang.Object
  org.apache.derby.impl.sql.execute.AggregatorInfo

All Implemented Interfaces:

java.io.Externalizable, org.apache.derby.iapi.services.io.Formatable, java.io.Serializable, org.apache.derby.iapi.services.io.TypedFormat

---

public class AggregatorInfo

extends java.lang.Object

implements org.apache.derby.iapi.services.io.Formatable

This is a simple class used to store the run time information needed to invoke an aggregator. This class is serializable because it is stored with the plan. It is serializable rather than externalizable because it isn't particularly complicated and presumbably we don't need version control on plans.

---

Field Summary
(package private)  java.lang.String	aggregateName           This class implements Formatable.
(package private)  java.lang.String	aggregatorClassName
(package private)  int	aggregatorColumn
(package private)  int	inputColumn
(package private)  boolean	isDistinct
(package private)  int	outputColumn
(package private)  org.apache.derby.iapi.sql.ResultDescription	rd

 

Constructor Summary

AggregatorInfo()           Niladic constructor for Formattable

AggregatorInfo(java.lang.String aggregateName, java.lang.String aggregatorClassName, int inputColNum, int outputColNum, int aggregatorColNum, boolean isDistinct, org.apache.derby.iapi.sql.ResultDescription rd)           Consructor

 

Method Summary
java.lang.String	getAggregateName()           Get the name of the aggergate (e.g.
java.lang.String	getAggregatorClassName()           Get the name of the class that implements the user aggregator for this class.
int	getAggregatorColNum()           Get the column number for the aggregator column.
int	getInputColNum()           Get the column number for the input (addend) column.
int	getOutputColNum()           Get the column number for the output (result) column.
org.apache.derby.iapi.sql.ResultDescription	getResultDescription()           Get the result description for the input value to this aggregate.
int	getTypeFormatId()           Get the formatID which corresponds to this class.
boolean	isDistinct()           Is the aggergate distinct
void	readExternal(java.io.ObjectInput in)           Read this object from a stream of stored objects.
java.lang.String	toString()           Get a string for the object
void	writeExternal(java.io.ObjectOutput out)           Write this object out

 

Methods inherited from class java.lang.Object

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

 

Field Detail

aggregateName

java.lang.String aggregateName

This class implements Formatable. That means that it can write itself to and from a formatted stream. If you add more fields to this class, make sure that you also write/read them with the writeExternal()/readExternal() methods. If, inbetween releases, you add more fields to this class, then you should bump the version number emitted by the getTypeFormatId() method. OR, since this is something that is used in stored prepared statements, it is ok to change it if you make sure that stored prepared statements are invalidated across releases.

---

inputColumn

int inputColumn

---

outputColumn

int outputColumn

---

aggregatorColumn

int aggregatorColumn

---

aggregatorClassName

java.lang.String aggregatorClassName

---

isDistinct

boolean isDistinct

---

rd

org.apache.derby.iapi.sql.ResultDescription rd

Constructor Detail

AggregatorInfo

public AggregatorInfo()

Niladic constructor for Formattable

---

AggregatorInfo

public AggregatorInfo(java.lang.String aggregateName,
                      java.lang.String aggregatorClassName,
                      int inputColNum,
                      int outputColNum,
                      int aggregatorColNum,
                      boolean isDistinct,
                      org.apache.derby.iapi.sql.ResultDescription rd)

Consructor

Method Detail

getAggregateName

public java.lang.String getAggregateName()

Get the name of the aggergate (e.g. MAX)

---

getAggregatorClassName

public java.lang.String getAggregatorClassName()

Get the name of the class that implements the user aggregator for this class.

---

getAggregatorColNum

public int getAggregatorColNum()

Get the column number for the aggregator column.

---

getInputColNum

public int getInputColNum()

Get the column number for the input (addend) column.

---

getOutputColNum

public int getOutputColNum()

Get the column number for the output (result) column.

---

isDistinct

public boolean isDistinct()

Is the aggergate distinct

---

getResultDescription

public org.apache.derby.iapi.sql.ResultDescription getResultDescription()

Get the result description for the input value to this aggregate.

---

toString

public java.lang.String toString()

Get a string for the object

---

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Write this object out

Specified by:

writeExternal in interface java.io.Externalizable

---

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Read this object from a stream of stored objects.

Specified by:

readExternal in interface java.io.Externalizable

---

getTypeFormatId

public int getTypeFormatId()

Get the formatID which corresponds to this class.

Specified by:

getTypeFormatId in interface org.apache.derby.iapi.services.io.TypedFormat

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> derby >> impl >> sql >> [ execute overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---