storedformatids.java

derby database source code.good for you.

/*

   Derby - Class org.apache.derby.iapi.services.io.StoredFormatIds

   Copyright 1997, 2004 The Apache Software Foundation or its licensors, as applicable.

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

 */

//depot/main/java/org.apache.derby.iapi.services.io/StoredFormatIds.java#211 - edit change 20974 (text)
package org.apache.derby.iapi.services.io;
/**
  A format id identifies a stored form of an object for the
  purposes of locating a class which can read the stored form and
  reconstruct the object using the java.io.Externalizable interface.

  <P>An important aspect of the format id concept is that it does
  not impose an implementation on the stored object. Rather,
  multiple implementations of an object (or interface) may share a
  format id. One implementation may store (write) an object
  and another may restore (read) the object. The implication of this
  is that a format id specifies the following properties of a
  stored object.

  <UL>
  <LI>The interface(s) the stored object must support. Any implementation
  which reads the object must support these interfaces.
  <LI>The format of the stored object. All implementaions which support
  the format must be able to read and write it.
  </UL>

  <P>An object should implement the Formatable inteface to support a
  stored format. In addition, the module which contains the object
  should register the object's class with the Monitor (See
  FormatIdUtil.register.)

  <P>When you add a format id to this file, please include the list
  of interfaces an implementaion must support when it supports
  the format id. When Cloudscape code reads a stored form it returns an 
  object of a Class which supports the stored form. A reader may
  cast this object to any interface listed in this file. It is an error for
  the reader to cast the object to a class or interface not listed in this
  file.

  <P>When you implement a class that supports a format, add a comment that
  states the name of the class. The first implementation of a format defines
  the stored form.

  <P>This interface defines all the format ids for Cloudscape software.
  If you define a format id please be sure to declare it in this
  file. If you remove support for a one please document that the
  format id is deprecated. Never remove or re-use a format id.
 */
public interface StoredFormatIds {

        /** Byte length of a two byt format id. */
        int  TWO_BYTE_FORMAT_ID_BYTE_LENGTH = 2;

        /** Minimum value for a two byte format id. */
        int  MIN_TWO_BYTE_FORMAT_ID = 0; //16384
        /** Maximum value for a two byte format id. */
        int  MAX_TWO_BYTE_FORMAT_ID = 0x7FFF; //32767
        
        int MIN_ID_2 = MIN_TWO_BYTE_FORMAT_ID;

        // TEMP DJD
        int MIN_ID_4 = MIN_ID_2 + 403;

        /******************************************************************
        **
        **      How to add an ID for another Formatable class 
    **
        **      o       In the list of constants below, identify the module that
        **              defines your class.
        **
        **      o       Add your class to the list to the end of that module 
        **              use a number that is one greater than all existing formats
        **              in that module, see MAX_ID_2 or MAX_ID_4 at the end of the 
        **              file, these are the largest existing formatId.
        **
        **      o       update MAX_ID_2 and MAX_ID_4
        **
        **
        **      o       Make sure that the getFormatId() method for your class
        **              returns the constant that you just made up.
        **
        **      o       Now find your module startup code that registers Format
        **              IDs. Add your class to that list.
        **
        **      o   Add a test for your new format ID to T_StoredFormat.java
        **
        ******************************************************************/


        /******************************************************************
        **
        **      Formats for the StoredFormatModule
        **
        **
        **
        ******************************************************************/

        /** Special format id for any null referance */
        static public final int NULL_FORMAT_ID =
                (MIN_ID_2 + 0);

        /** Special format id for tagging UTF8 strings */
        static public final int STRING_FORMAT_ID =
                (MIN_ID_2 + 1);

        /** Special format id for tagging Serializable objects. */
        static public final int SERIALIZABLE_FORMAT_ID =
                (MIN_ID_2 + 2);
        
        /******************************************************************
        **
        **      DataDictionary Formats
        **
        **
        **
        ******************************************************************/
        /**
            class org.apache.derby.iapi.types.BooleanTypeId
         */
        static public final int BOOLEAN_TYPE_ID =
                (MIN_ID_2 + 4);
        
        /**
            class org.apache.derby.iapi.types.BooleanTypeId
         */
        static public final int BOOLEAN_COMPILATION_TYPE_ID =
                (MIN_ID_2 + 260);
        
        /**
            class org.apache.derby.iapi.types.CharTypeId
         */
        static public final int CHAR_TYPE_ID =
                (MIN_ID_2 + 5);

        /**
            class org.apache.derby.iapi.types.CharTypeId
         */
        static public final int CHAR_COMPILATION_TYPE_ID =
                (MIN_ID_2 + 244);

        /**
            class org.apache.derby.iapi.types.DoubleTypeId
         */
        static public final int DOUBLE_TYPE_ID =
                (MIN_ID_2 + 6);
        
        /**
            class org.apache.derby.iapi.types.DoubleTypeId
         */
        static public final int DOUBLE_COMPILATION_TYPE_ID =
                (MIN_ID_2 + 245);
        
        /**
            class org.apache.derby.iapi.types.IntTypeId
         */
        static public final int INT_TYPE_ID =                            
                (MIN_ID_2 + 7);

        /**
            class org.apache.derby.iapi.types.IntTypeId
         */
        static public final int INT_COMPILATION_TYPE_ID =                                
                (MIN_ID_2 + 246);

        /**
            class org.apache.derby.iapi.types.RealTypeId
         */
        static public final int REAL_TYPE_ID =
                (MIN_ID_2 + 8);

        /**
            class org.apache.derby.iapi.types.RealTypeId
         */
        static public final int REAL_COMPILATION_TYPE_ID =
                (MIN_ID_2 + 247);

        /**
            class org.apache.derby.iapi.types.RefTypeId
         */
        static public final int REF_TYPE_ID =
                (MIN_ID_2 + 9);

        /**
            class org.apache.derby.iapi.types.RefTypeId
         */
        static public final int REF_COMPILATION_TYPE_ID =
                (MIN_ID_2 + 248);
        
        /**
            class org.apache.derby.iapi.types.SmallintTypeId
         */
        static public final int SMALLINT_TYPE_ID =
                (MIN_ID_2 + 10);
        
        /**
            class org.apache.derby.iapi.types.SmallintTypeId
         */
        static public final int SMALLINT_COMPILATION_TYPE_ID =
                (MIN_ID_2 + 249);
        
        /**
            class org.apache.derby.iapi.types.LongintTypeId
         */
        static public final int LONGINT_TYPE_ID =
                (MIN_ID_2 + 11);
        
        /**
            class org.apache.derby.iapi.types.LongintTypeId
         */
        static public final int LONGINT_COMPILATION_TYPE_ID =
                (MIN_ID_2 + 250);
        
        /**
            class org.apache.derby.iapi.types.UserDefinedTypeId
         */
        //static public final int USERDEFINED_TYPE_ID =
        //      (MIN_ID_2 + 12);
        
        /**
            class org.apache.derby.iapi.types.UserDefinedTypeIdV2
         */
        //static public final int USERDEFINED_TYPE_ID_V2 =
        //      (MIN_ID_2 + 267);
        /**
            class org.apache.derby.iapi.types.UserDefinedTypeIdV3
         */
        static public final int USERDEFINED_TYPE_ID_V3 =
                (MIN_ID_2 + 267);
        
        /**
            class org.apache.derby.iapi.types.UserDefinedTypeId
         */
        static public final int USERDEFINED_COMPILATION_TYPE_ID =
                (MIN_ID_2 + 251);
        
        /**
            class org.apache.derby.iapi.types.UserDefinedTypeIdV2
         */
        static public final int USERDEFINED_COMPILATION_TYPE_ID_V2 =
                (MIN_ID_2 + 265);
        
        /**
            class org.apache.derby.iapi.types.VarcharTypeId
         */
        static public final int VARCHAR_TYPE_ID =
                (MIN_ID_2 + 13);
        
        /**
            class org.apache.derby.iapi.types.VarcharTypeId
         */
        static public final int VARCHAR_COMPILATION_TYPE_ID =
                (MIN_ID_2 + 252);
        
        /**
        class org.apache.derby.catalog.types.TypeDescriptorImpl
        */
        static public final int DATA_TYPE_IMPL_DESCRIPTOR_V01_ID =
                (MIN_ID_2 + 14);
        
        /**
                class com.ibm.db2j.protcol.Datatypes.Execution.DataTypeDescriptor
         */
        static public final int DATA_TYPE_SERVICES_IMPL_V01_ID =
                (MIN_ID_2 + 259);

        /**
        class org.apache.derby.impl.sql.catalog.ConglomerateDescriptorFinder
     */
        static public final int CONGLOMERATE_DESCRIPTOR_FINDER_V01_ID =
                (MIN_ID_2 + 135);
        
        /**
        class org.apache.derby.impl.sql.catalog.ConstraintDescriptorFinder
     */
        static public final int CONSTRAINT_DESCRIPTOR_FINDER_V01_ID =
                (MIN_ID_2 + 208);
        
        /**
        class org.apache.derby.impl.sql.catalog.DefaultDescriptorFinder
     */
        static public final int DEFAULT_DESCRIPTOR_FINDER_V01_ID =
                (MIN_ID_2 + 325);
        
        /**
        class org.apache.derby.impl.sql.catalog.AliasDescriptorFinder
     */
        static public final int ALIAS_DESCRIPTOR_FINDER_V01_ID =
                (MIN_ID_2 + 136);

        /**
        class org.apache.derby.impl.sql.catalog.TableDescriptorFinder
     */
        static public final int TABLE_DESCRIPTOR_FINDER_V01_ID =
                (MIN_ID_2 + 137);
        
        /**
        class org.apache.derby.impl.sql.catalog.DataDictionaryDescriptorFinder
     */
        static public final int DATA_DICTIONARY_DESCRIPTOR_FINDER_V01_ID =
                (MIN_ID_2 + 138);
        
        /**
        class org.apache.derby.impl.sql.catalog.ViewDescriptorFinder
     */
        static public final int VIEW_DESCRIPTOR_FINDER_V01_ID =
                (MIN_ID_2 + 145);
        
        /**
        class org.apache.derby.impl.sql.catalog.SPSDescriptorFinder
     */
        static public final int SPS_DESCRIPTOR_FINDER_V01_ID =
                (MIN_ID_2 + 226);

        /**
        class org.apache.derby.impl.sql.catalog.FileInfoFinder
     */
        static public final int FILE_INFO_FINDER_V01_ID =
                (MIN_ID_2 + 273);

        /**
        class org.apache.derby.impl.sql.catalog.TriggerDescriptorFinder
     */
        static public final int TRIGGER_DESCRIPTOR_FINDER_V01_ID =
                (MIN_ID_2 + 320);

        /**
        class org.apache.derby.impl.sql.catalog.TriggerDescriptorFinder
     */
        static public final int TRIGGER_DESCRIPTOR_V01_ID =
                (MIN_ID_2 + 316);

        /**
        class org.apache.derby.impl.sql.catalog.DD_SocratesVersion
     */
        static public final int DD_SOCRATES_VERSION_ID =
                (MIN_ID_2 + 174);
        
        /**
        class org.apache.derby.catalog.types.ReferencedColumnsDescriptorImpl
     */
        static public final int REFERENCED_COLUMNS_DESCRIPTOR_IMPL_V01_ID =
                (MIN_ID_2 + 205);
        
        /**
        class org.apache.derby.impl.sql.catalog.DD_PlatoVersion
     */
        static public final int DD_PLATO_VERSION_ID =
                (MIN_ID_2 + 206);

        /**
        class org.apache.derby.impl.sql.catalog.DD_AristotleVersion
     */
        static public final int DD_ARISTOTLE_VERSION_ID =
                (MIN_ID_2 + 272);

        /**
          class org.apache.derby.impl.sql.catalog.DD_XenaVersion
     */
        static public final int DD_XENA_VERSION_ID =
                (MIN_ID_2 + 302);

        /**
          class org.apache.derby.impl.sql.catalog.DD_BuffyVersion
     */
        static public final int DD_BUFFY_VERSION_ID =
                (MIN_ID_2 + 373);

        /**
          class org.apache.derby.impl.sql.catalog.DD_MulanVersion
     */
        static public final int DD_MULAN_VERSION_ID =
                (MIN_ID_2 + 376);

        /**
          class org.apache.derby.impl.sql.catalog.DD_IvanovaVersion
     */
        static public final int DD_IVANOVA_VERSION_ID =
                (MIN_ID_2 + 396);

        /**
          class org.apache.derby.impl.sql.catalog.DD_DB2J72
		  now mapped to a single class DD_Version.
		  5.0 databases will have this as the format identifier for their
		  catalog version number.
     */
        static public final int DD_DB2J72_VERSION_ID =
                (MIN_ID_2 + 401);

        /**
          class org.apache.derby.impl.sql.catalog.DD_Version
 		  now mapped to a single class DD_Version.
		  5.1 and later databases will have this as the format identifier for their
		  catalog version number.
    */
        static public final int DD_ARWEN_VERSION_ID =
                (MIN_ID_2 + 402);
        
        /**
                class org.apache.derby.iapi.types.LongvarcharTypeId
         */
        static public final int LONGVARCHAR_TYPE_ID =
                (MIN_ID_2 + 230);
        
        /**
                class org.apache.derby.iapi.types.LongvarcharTypeId
         */
        static public final int LONGVARCHAR_COMPILATION_TYPE_ID =
                (MIN_ID_2 + 256);

        /**
                class org.apache.derby.iapi.types.LongvarcharTypeId
         */
        static public final int CLOB_TYPE_ID =
                (MIN_ID_2 + 444);
        
        /**
                class org.apache.derby.iapi.types.LongvarcharTypeId
         */
        static public final int CLOB_COMPILATION_TYPE_ID =
                (MIN_ID_2 + 445);

        /**
                class org.apache.derby.iapi.types.LongvarbitTypeId
                - XXXX does not exist!!!
         */
        static public final int LONGVARBIT_TYPE_ID =
                (MIN_ID_2 + 232);

        /**
                class org.apache.derby.iapi.types.LongvarbitTypeId
                - XXXX does not exist!!!
         */
        static public final int LONGVARBIT_COMPILATION_TYPE_ID =
                (MIN_ID_2 + 255);

        /**
                class org.apache.derby.iapi.types.LongvarbitTypeId
                - XXXX does not exist!!!
        But for BLOB we do the same as for LONGVARBIT, only need different ids
         */
        static public final int BLOB_TYPE_ID =
                (MIN_ID_2 + 440);

        /**