Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.openjpa.jdbc.kernel
Class ValueTableJDBCSeq

    java.lang.Object
      org.apache.openjpa.jdbc.kernel.AbstractJDBCSeq
          org.apache.openjpa.jdbc.kernel.TableJDBCSeq
              org.apache.openjpa.jdbc.kernel.ValueTableJDBCSeq

All Implemented Interfaces:
  JDBCSeq, Seq, Configurable, Closeable

    public class ValueTableJDBCSeq

extends TableJDBCSeq

Specialization of the `TableJDBCSeq` that maintains multiple sequence counts. Each instance of this class represents one row with a known string primary key value, more or less. The table name defaults to `OPENJPA_SEQUENCES_TABLE`.

Author:
  Abe White

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.openjpa.jdbc.kernel.TableJDBCSeq
`TableJDBCSeq.Status`

Field Summary
`static String` | `PK_VALUE`

Fields inherited from class org.apache.openjpa.jdbc.kernel.TableJDBCSeq
`ACTION_ADD, ACTION_DROP, ACTION_GET, ACTION_SET`

Fields inherited from class org.apache.openjpa.jdbc.kernel.AbstractJDBCSeq
`current, type`

Fields inherited from interface org.apache.openjpa.kernel.Seq
`TYPE_CONTIGUOUS, TYPE_DEFAULT, TYPE_NONTRANSACTIONAL, TYPE_TRANSACTIONAL`

Constructor Summary
`ValueTableJDBCSeq()`

Method Summary
`protected Column` | `addPrimaryKeyColumn(Table table)` Add the primary key column to the given table and return it.
`protected Object` | `getPrimaryKey(ClassMapping mapping)` Return the primary key value for the given class.
`String` | `getPrimaryKeyValue()` The primary key value for this row.
`static void` | `main(String[] args)` Usage: java org.apache.openjpa.jdbc.kernel.ValueTableJDBCSeq [option]* -action/-a <add | drop | get | set> [primary key value] [value] Where the following options are recognized.
`static boolean` | `run(JDBCConfiguration conf, String[] args, Options opts)` Run the tool.
`static boolean` | `run(JDBCConfiguration conf, String[] args, String action, MappingRepository repos, ClassLoader loader)` Run the tool.
`void` | `setPrimaryKeyValue(String value)` The primary key value for this row.

Methods inherited from class org.apache.openjpa.jdbc.kernel.TableJDBCSeq
`addSchema, allocateInternal, currentInternal, dropTable, endConfiguration, getAllocate, getConfiguration, getPrimaryKeyColumn, getSequence, getSequenceColumn, getStatus, getTable, nextInternal, refreshTable, run, setAllocate, setConfiguration, setIncrement, setPrimaryKeyColumn, setSequence, setSequenceColumn, setTable, setTableName, startConfiguration`

Methods inherited from class org.apache.openjpa.jdbc.kernel.AbstractJDBCSeq
`allocate, close, closeConnection, current, getConnection, next, setType`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### PK_VALUE

    public static final String PK_VALUE

See Also:
  Constant Field Values

Constructor Detail

### ValueTableJDBCSeq

    public ValueTableJDBCSeq()

Method Detail

### getPrimaryKeyValue

    public String getPrimaryKeyValue()

  The primary key value for this row. Defaults to `DEFAULT`.

### setPrimaryKeyValue

    public void setPrimaryKeyValue(String value)

  The primary key value for this row. Defaults to `DEFAULT`.

### addPrimaryKeyColumn

    protected Column addPrimaryKeyColumn(Table table)

  Description copied from class: `TableJDBCSeq`
  Add the primary key column to the given table and return it.

  Overrides:
    `addPrimaryKeyColumn` in class `TableJDBCSeq`

### getPrimaryKey

    protected Object getPrimaryKey(ClassMapping mapping)

  Description copied from class: `TableJDBCSeq`
  Return the primary key value for the given class.

  Overrides:
    `getPrimaryKey` in class `TableJDBCSeq`

### main

    public static void main(String[] args)
                     throws Exception

  Usage: java org.apache.openjpa.jdbc.kernel.ValueTableJDBCSeq [option]* -action/-a <add | drop | get | set> [primary key value] [value] Where the following options are recognized.
  - -properties/-p <properties file or resource>: The path or resource name of a OpenJPA properties file containing information such as the license key and connection data as outlined in `JDBCConfiguration`. Optional.
  - -<property name> <property value>: All bean properties of the OpenJPA `JDBCConfiguration` can be set by using their names and supplying a value. For example: `-licenseKey adslfja83r3lkadf`
  The various actions are as follows.
  - add: Create the sequence table.
  - drop: Drop the sequence table.
  - get: Print the current sequence value for the given primary key value.
  - set: Set the sequence value for the given primary key value.

  Throws:
    `Exception`

### run

    public static boolean run(JDBCConfiguration conf,
                              String[] args,
                              Options opts)
                       throws Exception

  Run the tool. Returns false if invalid options were given.

  Throws:
    `Exception`

### run

    public static boolean run(JDBCConfiguration conf,
                              String[] args,
                              String action,
                              MappingRepository repos,
                              ClassLoader loader)
                       throws Exception

  Run the tool. Return false if an invalid option was given.

  Throws:
    `Exception`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2006 Apache Software Foundation. All Rights Reserved.