# Serialized Form

- ## Package org.apache.torque

  - ### Class org.apache.torque.ColumnImpl extends Object implements Serializable

    serialVersionUID:
      1L

    - ### Serialized Fields

      - #### columnName

            String columnName

        The column name, may be null but not empty.

      - #### tableName

            String tableName

        The table name, may be null but not empty.

      - #### schemaName

            String schemaName

        The schema name, may be null but not empty.

      - #### sqlExpression

            String sqlExpression

        The SQL expression for the column, not null.

  - ### Class org.apache.torque.ConstraintViolationException extends TorqueException implements Serializable

    serialVersionUID:
      1L

  - ### Class org.apache.torque.DeadlockException extends TorqueException implements Serializable

    serialVersionUID:
      1L

  - ### Class org.apache.torque.NoRowsException extends TorqueException implements Serializable

    serialVersionUID:
      199486766559455753L

  - ### Class org.apache.torque.OptimisticLockingFailedException extends TorqueException implements Serializable

    serialVersionUID:
      1L

  - ### Class org.apache.torque.TooManyRowsException extends TorqueException implements Serializable

    serialVersionUID:
      -2875429969148699158L

  - ### Class org.apache.torque.TorqueException extends SQLException implements Serializable

    serialVersionUID:
      3090544800848674368L

  - ### Class org.apache.torque.TorqueRuntimeException extends RuntimeException implements Serializable

    serialVersionUID:
      -2997617341459640541L

- ## Package org.apache.torque.adapter

  - ### Class org.apache.torque.adapter.AbstractAdapter extends Object implements Serializable

    serialVersionUID:
      1L

    - ### Serialized Fields

      - #### useGetGeneratedKeys

            boolean useGetGeneratedKeys

        A flag to determine whether Statement#getGeneratedKeys() should be used.

  - ### Class org.apache.torque.adapter.DerbyAdapter extends AbstractAdapter implements Serializable

    serialVersionUID:
      6265962681516206415L

  - ### Class org.apache.torque.adapter.HsqldbAdapter extends AbstractAdapter implements Serializable

    serialVersionUID:
      8392727399615702372L

  - ### Class org.apache.torque.adapter.MssqlAdapter extends AbstractAdapter implements Serializable

    serialVersionUID:
      -2924485528975497044L

  - ### Class org.apache.torque.adapter.MysqlAdapter extends AbstractAdapter implements Serializable

    serialVersionUID:
      7547291410802807010L

  - ### Class org.apache.torque.adapter.NoneAdapter extends AbstractAdapter implements Serializable

    serialVersionUID:
      -285009315025818009L

  - ### Class org.apache.torque.adapter.OracleAdapter extends AbstractAdapter implements Serializable

    serialVersionUID:
      8966976210230241194L

  - ### Class org.apache.torque.adapter.PostgresAdapter extends AbstractAdapter implements Serializable

    serialVersionUID:
      7643304924262475272L

- ## Package org.apache.torque.criteria

  - ### Class org.apache.torque.criteria.Criteria extends Object implements Serializable

    serialVersionUID:
      -9001666575933085601L

    - ### Serialized Fields

      - #### ignoreCase

            boolean ignoreCase

        Whether to ignore the case in all String conditions in the criteria.

      - #### singleRecord

            boolean singleRecord

        Whether the result must be a single record.

      - #### selectModifiers

            UniqueList<T> selectModifiers

        List of modifiers like DISTICT.

      - #### selectColumns

            UniqueColumnList selectColumns

        List of all columns to select.

      - #### orderByColumns

            UniqueList<T> orderByColumns

        All "order by" clauses, containing the order ASC or DESC.

      - #### groupByColumns

            UniqueColumnList groupByColumns

        The names of columns to add to a groupBy clause

      - #### fromElements

            UniqueList<T> fromElements

        All "from" clauses. Empty if the from clause should be computed automatically.

      - #### having

            Criterion having

        The having clause in a query.

      - #### forUpdate

            boolean forUpdate

        Whether a FOR UPDATE clause should be added.

      - #### topLevelCriterion

            Criterion topLevelCriterion

        The criterion objects, keyed by the column.

      - #### asColumns

            Map<K,V> asColumns

        Maps column alias names to the real column names. The key of the map is the alias and the value is the real column.

      - #### joins

            List<E> joins

        Contains all joins.

      - #### dbName

            String dbName

        The name of the database in which this criteria should execute.

      - #### limit

            int limit

        To limit the number of rows to return. `-1` means return all rows.

      - #### offset

            long offset

        To start the results at a row other than the first one.

      - #### aliases

            Map<K,V> aliases

        Aliases for table names. The key of the map is the alias, and the value is either the real name of the table or a corresponding subselect.

      - #### fetchSize

            Integer fetchSize

        The JDBC statement fetch size, if any.

      - #### setOperator

            SqlEnum setOperator

        The operator used to connect the crizeria parts for set operations.

      - #### setCriteriaParts

            List<E> setCriteriaParts

        The parts of a Criteria which consists of several criteria connected by a set operation. Set operations are e.g. UNION, INTERSECT, EXCEPT...

  - ### Class org.apache.torque.criteria.Criterion extends Object implements Serializable

    serialVersionUID:
      7157097965404611710L

    - ### Serialized Fields

      - #### lValue

            Object lValue

        Left-hand-side value of the comparison, may be null. If this object implements the Column interface, it is interpreted as a value computed by the database, otherwise as verbatim value.

      - #### comparison

            SqlEnum comparison

        Comparison operator. Can only be null if sql is not null.

      - #### rValue

            Object rValue

        Right-hand-side value of the comparison, may be null. If this object implements the Column interface, it is interpreted as a value computed by the database, otherwise as verbatim value.

      - #### sql

            String sql

        A verbatim SQL for this Criterion.

      - #### preparedStatementReplacements

            Object[] preparedStatementReplacements

        Replacements for the placeholders in the verbatim SQL. Is only used if sql is not null.

      - #### ignoreCase

            boolean ignoreCase

        Flag to ignore case in comparison

      - #### parts

            List<E> parts

        The criterion objects which form a composite criterion. Either this list is not null and represents this criterion or the column, value, comparison and ignoreStringCase columns are not null and represent this criterion.

      - #### conjunction

            String conjunction

        The operator (AND, OR...) how the composite criterions are connected.

  - ### Class org.apache.torque.criteria.FromElement extends Object implements Serializable

    serialVersionUID:
      1L

    - ### Serialized Fields

      - #### fromExpression

            String fromExpression

        The fromExpression, e.g. a simple table name or a table name or a subquery with an appended alias name.

      - #### joinType

            JoinType joinType

        The type of the join, e.g. JoinType.LEFT_JOIN

      - #### joinCondition

            String joinCondition

        The join condition, e.g. table_a.id = table_b.a_id

      - #### preparedStatementReplacements

            List<E> preparedStatementReplacements

        The replacements which might occur in the fromExpression.

  - ### Class org.apache.torque.criteria.Join extends Object implements Serializable

    serialVersionUID:
      1L

    - ### Serialized Fields

      - #### joinCondition

            Criterion joinCondition

        The join condition, not null.

      - #### leftTable

            PreparedStatementPart leftTable

        The left table of the join, or null to be determined from join condition.

      - #### rightTable

            PreparedStatementPart rightTable

        The right table of the join, or null to be determined from join condition.

      - #### joinType

            JoinType joinType

        The type of the join (LEFT JOIN, ...), or null for an implicit inner join.

  - ### Class org.apache.torque.criteria.PreparedStatementPartImpl extends Object implements Serializable

    serialVersionUID:
      1L

    - ### Serialized Fields

      - #### sql

            StringBuilder sql

        The SQL for the part, not null.

      - #### preparedStatementReplacements

            List<E> preparedStatementReplacements

        The replacements for the prepared statement, not null.

  - ### Class org.apache.torque.criteria.SqlEnum extends Object implements Serializable

    serialVersionUID:
      5963149836513364800L

    - ### Serialized Fields

      - #### s

            String s

        The SQL expression.

      - #### numberOfCompareOperands

            int numberOfCompareOperands

        The number of operands, if the SqlEnum is a comparison operator. -1 if the SqlEnum is no comparison operator. A Set operand (e.g. in IN) is counted as one operand.

- ## Package org.apache.torque.manager

  - ### Class org.apache.torque.manager.AbstractBaseManager extends Object implements Serializable

    serialVersionUID:
      509798299473481305L

    - ### Serialization Methods

      - #### readObject

            private void readObject(ObjectInputStream in)
                             throws IOException,
                                    ClassNotFoundException

        Helper methods for the `Serializable` interface.
        Throws:
          `IOException` - if input stream cannot be read
          `ClassNotFoundException` - if the class is not found

      - #### writeObject

            private void writeObject(ObjectOutputStream out)
                              throws IOException

        helper methods for the Serializable interface
        Throws:
          `IOException` - if output stream not found

    - ### Serialized Fields

      - #### omClass

            Class<T> omClass

        The OM class that the service will instantiate.

      - #### className

            String className

        The name of the OM class that the service will instantiate.

      - #### region

            String region

        The cache region used for JCS.

      - #### isNew

            boolean isNew

        Whether the cache manager has already registered its cache Listeners.

      - #### validFields

            CopyOnWriteArraySet<E> validFields

        The fields which are valid fields of interest for a listener.

      - #### listenersMap

            ConcurrentMap<K,V> listenersMap

        The listeners for this manager.

  - ### Class org.apache.torque.manager.MethodCacheKey extends Object implements Serializable

    serialVersionUID:
      -1831486431185021200L

    - ### Serialized Fields

      - #### instanceOrClass

            Serializable instanceOrClass

        The Object on which the method is invoked. If the method is static, a String representing the class name is used.

      - #### method

            String method

        The method name.

      - #### args

            Serializable[] args

        Optional arguments for the method.

      - #### groupKey

            String groupKey

        The cache group key.

- ## Package org.apache.torque.map

  - ### Class org.apache.torque.map.ColumnMap extends OptionSupport implements Serializable

    serialVersionUID:
      1L

    - ### Serialized Fields

      - #### type

            Object type

        A sample object having the same java Type as the column.

      - #### torqueType

            String torqueType

        The name of the Torque Type of the column.

      - #### usePrimitive

            boolean usePrimitive

        Should object type be converted to primitive.

      - #### size

            int size

        Size of the column.

      - #### scale

            int scale

        Scale of the column

      - #### pk

            boolean pk

        Is it a primary key?

      - #### notNull

            boolean notNull

        Is null value allowed ?

      - #### table

            TableMap table

        The TableMap for this column.

      - #### columnName

            String columnName

        The name of the column.

      - #### javaName

            String javaName

        The Java Name of this column as defined in XML or created by the generator code.

      - #### autoIncrement

            boolean autoIncrement

        Is this column an autoincrement column ?

      - #### description

            String description

        Column description info (if any).

      - #### isProtected

            boolean isProtected

        is Column protected ?

      - #### defaultValue

            String defaultValue

        String representing the default value defined for field. Note that default is a keyword, so defaultValue is used to store the value for the get/setDefault() methods.

      - #### inheritance

            String inheritance

        Inheritance type used.

      - #### useInheritance

            boolean useInheritance

        Does column uses Inheritance subclasses? Note that this is tied to the TableMap useInheritance thru the set function.

      - #### inheritanceMaps

            Map<K,V> inheritanceMaps

        Associated of inheritance maps.

      - #### javaNamingMethod

            String javaNamingMethod

        Java naming method the generator used.

      - #### javaType

            String javaType

        Java type string specified in XML.

      - #### position

            int position

        Column position in the table (one based).

  - ### Class org.apache.torque.map.DatabaseMap extends OptionSupport implements Serializable

    serialVersionUID:
      1L

    - ### Serialized Fields

      - #### name

            String name

        The name of the database where this databaseMap belongs to, for internal purposes only.

      - #### tables

            Map<K,V> tables

        Name of the tables in the database.

      - #### idTable

            TableMap idTable

        The id Table.

      - #### isInitialized

            boolean isInitialized

        Flag indicating that all tables have been loaded via initialize()

  - ### Class org.apache.torque.map.ForeignKeyMap extends Object implements Serializable

    serialVersionUID:
      1L

    - ### Serialized Fields

      - #### table

            TableMap table

        The table to which the foreign key belongs, not null.

      - #### foreignTable

            TableMap foreignTable

        The table which is referenced by the foreign key, can be null if the foreign table is not yet in the database map.

      - #### foreignTableName

            String foreignTableName

        The name of the foreign table, in the case that the foreign table map builder was not yet built when this foreign key was initialized.

      - #### columns

            List<E> columns

        The column pairs for the foreign key, not null, not empty,

  - ### Class org.apache.torque.map.ForeignKeyMap.ColumnPair extends Object implements Serializable

    serialVersionUID:
      1L

    - ### Serialized Fields

      - #### foreignKeyMap

            ForeignKeyMap foreignKeyMap

        The foreign key map this ColumnPair belongs to.

      - #### local

            ColumnMap local

        The foreign column of the pair, not null.

      - #### foreign

            ColumnMap foreign

        The foreign column of the pair, can be null if the foreign table was not yet in the database.

      - #### foreignName

            String foreignName

        The name of foreign column of the pair, or null if the foreign column is already filled.

  - ### Class org.apache.torque.map.InheritanceMap extends Object implements Serializable

    serialVersionUID:
      1L

    - ### Serialized Fields

      - #### key

            String key

        The value in the related column that is associated with this information.

      - #### className

            String className

        The name of the class which impliments this inheritance mode.

      - #### ancestor

            String ancestor

        The name of class which class name extends. Retrieved via getExtends().

      - #### column

            ColumnMap column

        The column this info is related to.

  - ### Class org.apache.torque.map.OptionSupport extends Object implements Serializable

    serialVersionUID:
      1L

    - ### Serialized Fields

      - #### optionsMap

            Map<K,V> optionsMap

        Associated options.

  - ### Class org.apache.torque.map.TableMap extends OptionSupport implements Serializable

    serialVersionUID:
      1L

    - ### Serialized Fields

      - #### columns

            Map<K,V> columns

        The columns in the table. XML Order is preserved.

      - #### foreignKeys

            List<E> foreignKeys

        The foreign keys in the table. XML Order is preserved.

      - #### dbMap

            DatabaseMap dbMap

        The database this table belongs to.

      - #### tableName

            String tableName

        The name of the table.

      - #### schemaName

            String schemaName

        The name of the schema to which this table belongs, or null for the default schema.

      - #### javaName

            String javaName

        The JavaName of the table as defined in XML

      - #### prefix

            String prefix

        The prefix on the table name.

      - #### primaryKeyMethod

            IDMethod primaryKeyMethod

        The primary key generation method.

      - #### description

            String description

        The table description info.

      - #### peerClass

            Class<T> peerClass

        The Peer Class for this table.

      - #### omClass

            Class<T> omClass

        The OM Root Class for this table.

      - #### useInheritance

            boolean useInheritance

        Whether any column uses Inheritance.

      - #### useManager

            boolean useManager

        Whether cache managers are used.

      - #### managerClass

            Class<T> managerClass

        The associated cache manager class.

      - #### pkInfoOverride

            Object pkInfoOverride

        Overrides the information stored in the pkInfoMap for all id methods.

      - #### pkInfoMap

            Map<K,V> pkInfoMap

        Stores information that is needed for generating primary keys. The information is keyed by the idMethodType because it might be different for different id methods.

- ## Package org.apache.torque.om

  - ### Class org.apache.torque.om.BooleanKey extends SimpleKey<Boolean> implements Serializable

    serialVersionUID:
      5109588772086713341L

  - ### Class org.apache.torque.om.ComboKey extends ObjectKey<SimpleKey<?>[]> implements Serializable

    serialVersionUID:
      -264927663211141894L

  - ### Class org.apache.torque.om.DateKey extends SimpleKey<Date> implements Serializable

    serialVersionUID:
      3102583536685348517L

  - ### Class org.apache.torque.om.NumberKey extends SimpleKey<BigDecimal> implements Serializable

    serialVersionUID:
      -5566819786708264162L

  - ### Class org.apache.torque.om.ObjectKey extends Object implements Serializable

    serialVersionUID:
      1L

    - ### Serialized Fields

      - #### key

            Object key

        The underlying key value.

  - ### Class org.apache.torque.om.SimpleKey extends ObjectKey<T> implements Serializable

    serialVersionUID:
      1L

  - ### Class org.apache.torque.om.StringKey extends SimpleKey<String> implements Serializable

    serialVersionUID:
      5109588772086713341L

- ## Package org.apache.torque.om.mapper

  - ### Class org.apache.torque.om.mapper.BigDecimalMapper extends Object implements Serializable

    serialVersionUID:
      1L

    - ### Serialized Fields

      - #### internalOffset

            int internalOffset

        The internal offset for the mapper.

  - ### Class org.apache.torque.om.mapper.CompositeMapper extends Object implements Serializable

    serialVersionUID:
      1L

    - ### Serialized Fields

      - #### mapperList

            List<E> mapperList

        All mappers which should be appliead to a result set, combined with their individual offset.

  - ### Class org.apache.torque.om.mapper.DateMapper extends Object implements Serializable

    serialVersionUID:
      1L

    - ### Serialized Fields

      - #### internalOffset

            int internalOffset

        The internal offset for the mapper.

  - ### Class org.apache.torque.om.mapper.IntegerMapper extends Object implements Serializable

    serialVersionUID:
      1L

    - ### Serialized Fields

      - #### internalOffset

            int internalOffset

        The internal offset for the mapper.

  - ### Class org.apache.torque.om.mapper.LongMapper extends Object implements Serializable

    serialVersionUID:
      1L

    - ### Serialized Fields

      - #### internalOffset

            int internalOffset

        The internal offset for the mapper.

  - ### Class org.apache.torque.om.mapper.ObjectListMapper extends Object implements Serializable

    serialVersionUID:
      1L

    - ### Serialized Fields

      - #### convertClasses

            List<E> convertClasses

        Contains the classes to which the columns are mapped. The size of the list determines how many columns are read.

  - ### Class org.apache.torque.om.mapper.StringMapper extends Object implements Serializable

    serialVersionUID:
      1L

    - ### Serialized Fields

      - #### internalOffset

            int internalOffset

        The internal offset for the mapper.

- ## Package org.apache.torque.sql

  - ### Class org.apache.torque.sql.OrderBy extends Object implements Serializable

    serialVersionUID:
      1L

    - ### Serialized Fields

      - #### column

            Column column

        The column to order by.

      - #### order

            SqlEnum order

        The order to order by (ascending or descending).

      - #### ignoreCase

            boolean ignoreCase

        Whether case should be ignored for String columns.

- ## Package org.apache.torque.util

  - ### Class org.apache.torque.util.AbstractPeerImpl extends BasePeerImpl<T extends ObjectModel> implements Serializable

    serialVersionUID:
      1236684692145864194L

  - ### Class org.apache.torque.util.BasePeerImpl extends Object implements Serializable

    serialVersionUID:
      -7702123730779032381L

    - ### Serialized Fields

      - #### recordMapper

            RecordMapper<T> recordMapper

        An injected instance of a record mapper to map JDBC result sets to objects

      - #### tableMap

            TableMap tableMap

        An injected instance of a table map

      - #### databaseName

            String databaseName

        An injected instance of the database name

  - ### Class org.apache.torque.util.LargeSelect extends Object implements Serializable

    serialVersionUID:
      -1166842932571491942L

    - ### Serialization Methods

      - #### readObject

            private void readObject(ObjectInputStream inputStream)
                             throws IOException,
                                    ClassNotFoundException

        De-serialize this LargeSelect instance.
        Throws:
          `IOException` - if input stream cannot be read
          `ClassNotFoundException` - if class not found

    - ### Serialized Fields

      - #### pageSize

            int pageSize

        The number of records that a page consists of.

      - #### memoryLimit

            int memoryLimit

        The maximum number of records to maintain in memory.

      - #### currentlyFilledTo

            int currentlyFilledTo

        How much of the memory block is currently occupied with result data.

      - #### position

            int position

        The cursor position in the result set.

      - #### totalPages

            int totalPages

        The total number of pages known to exist.

      - #### totalRecords

            int totalRecords

        The total number of records known to exist.

      - #### criteria

            Criteria criteria

        The criteria used for the query.

      - #### peer

            BasePeerImpl<T> peer

        The BasePeerImpl object that handles database selects.

      - #### pageProgressTextPattern

            String pageProgressTextPattern

        The MessageFormat pattern to format a page progress. The default

            {0} of {1,choice,0#> |1#}{2}

        formats as

            2 of 3

        . if the total number of records or pages is unknown, the pattern formats as

            2 of > 3

        . You can use `setPageProgressTextPattern()` to change this to whatever value you like.

      - #### recordProgressTextPattern

            String recordProgressTextPattern

        The MessageFormat pattern to format a record progress. The default

            {0} - {1} of {2,choice,0#> |1#}{3}

        formats as

            1 - 25 of 100

        . if the total number of records or pages is unknown, the pattern formats as

            1 - 25 of > 100

        . You can use `setRecordProgressTextPattern()` to change this to whatever value you like.

      - #### memoryPageLimit

            int memoryPageLimit

        The maximum number of pages of data to be retained in memory. Use `setMemoryPageLimit()` to provide your own value.

      - #### params

            Map<K,V> params

        A place to store search parameters that relate to this query.

  - ### Class org.apache.torque.util.ListOrderedMapCI extends LinkedHashMap<String,T> implements Serializable

    serialVersionUID:
      -4349246328751938554L

  - ### Class org.apache.torque.util.UniqueColumnList extends ArrayList<Column> implements Serializable

    serialVersionUID:
      4467847559423445120L

  - ### Class org.apache.torque.util.UniqueList extends ArrayList<T> implements Serializable

    serialVersionUID:
      4467847559423445120L

Copyright © 2000–2020 The Apache Software Foundation. All rights reserved.