Java Doc for AbstractPoidGenerator.java in  » Database-ORM » JPOX » org » jpox » store » poid » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation 1.  6.0 JDK Core 2.  6.0 JDK Modules 3.  6.0 JDK Modules com.sun 4.  6.0 JDK Modules com.sun.java 5.  6.0 JDK Modules sun 6.  6.0 JDK Platform 7.  Ajax 8.  Apache Harmony Java SE 9.  Aspect oriented 10.  Authentication Authorization 11.  Blogger System 12.  Build 13.  Byte Code 14.  Cache 15.  Chart 16.  Chat 17.  Code Analyzer 18.  Collaboration 19.  Content Management System 20.  Database Client 21.  Database DBMS 22.  Database JDBC Connection Pool 23.  Database ORM 24.  Development 25.  EJB Server geronimo 26.  EJB Server GlassFish 27.  EJB Server JBoss 4.2.1 28.  EJB Server resin 3.1.5 29.  ERP CRM Financial 30.  ESB 31.  Forum 32.  GIS 33.  Graphic Library 34.  Groupware 35.  HTML Parser 36.  IDE 37.  IDE Eclipse 38.  IDE Netbeans 39.  Installer 40.  Internationalization Localization 41.  Inversion of Control 42.  Issue Tracking 43.  J2EE 44.  JBoss 45.  JMS 46.  JMX 47.  Library 48.  Mail Clients 49.  Net 50.  Parser 51.  PDF 52.  Portal 53.  Profiler 54.  Project Management 55.  Report 56.  RSS RDF 57.  Rule Engine 58.  Science 59.  Scripting 60.  Search Engine 61.  Security 62.  Sevlet Container 63.  Source Control 64.  Swing Library 65.  Template Engine 66.  Test Coverage 67.  Testing 68.  UML 69.  Web Crawler 70.  Web Framework 71.  Web Mail 72.  Web Server 73.  Web Services 74.  Web Services apache cxf 2.0.1 75.  Web Services AXIS2 76.  Wiki Engine 77.  Workflow Engines 78.  XML 79.  XML UI Java Java Tutorial Java Open Source Jar File Download Java Articles Java Products Java by API Photoshop Tutorials Maya Tutorials Flash Tutorials 3ds-Max Tutorials Illustrator Tutorials GIMP Tutorials C# / C Sharp C# / CSharp Tutorial C# / CSharp Open Source ASP.Net ASP.NET Tutorial JavaScript DHTML JavaScript Tutorial JavaScript Reference HTML / CSS HTML CSS Reference C / ANSI-C C Tutorial C++ C++ Tutorial Ruby PHP Python Python Tutorial Python Open Source SQL Server / T-SQL SQL Server / T-SQL Tutorial Oracle PL / SQL Oracle PL/SQL Tutorial PostgreSQL SQL / MySQL MySQL Tutorial VB.Net VB.Net Tutorial Flash / Flex / ActionScript VBA / Excel / Access / Word XML XML Tutorial Microsoft Office PowerPoint 2007 Tutorial Microsoft Office Excel 2007 Tutorial Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Database ORM » JPOX » org.jpox.store.poid   Source Cross Reference   Class Diagram   Java Document (Java Doc)   java.lang.Object    org.jpox.store.poid.AbstractPoidGenerator All known Subclasses:   org.jpox.store.poid.AbstractDatastorePoidGenerator,  org.jpox.store.poid.AbstractUIDPoidGenerator, AbstractPoidGenerator abstract public class AbstractPoidGenerator implements PoidGenerator(Code) Abstract POID generator. version:    $Revision: 1.9 $ Field Summary final protected static  Localiser LOCALISER      protected  int allocationSize      protected  int initialValue      Initial value (of the first id). protected  String name      Symbolic name for the sequence. protected  PoidBlock poidBlock      The current block of ids that have been reserved. protected  Properties properties      Properties controlling the generator behaviour. Constructor Summary public   AbstractPoidGenerator(String name, Properties props)      Constructor. Method Summary public synchronized  void allocate(int additional)      Method to allocate a number of values into the block. protected  boolean createRepository()      Method to create any needed repository for the ids. public synchronized  Object current()      Accessor for the current value allocated. public  long currentValue()      Accessor for the current element in the sequence as a long. public  String getName()      Accessor for the symbolic name for this generator. public static  Class getStorageClass()      Accessor for the storage class for POIDs generated with this generator. public synchronized  Object next()      Get next value from the reserved block of values. public  long nextValue()      Accessor for the next element in the sequence as a long. protected  PoidBlock obtainPoidBlock()      Get a new PoidBlock with the default number of ids. protected  PoidBlock obtainPoidBlock(int number)      Get a new PoidBlock with the specified number of ids. protected  boolean requiresRepository()      Indicator for whether the generator requires its own repository. protected  PoidBlock reserveBlock()      Method to reserve a default sized block of identities. abstract protected  PoidBlock reserveBlock(long size)      Method to reserve a blobk of "size" ids. Field Detail LOCALISER final protected static Localiser LOCALISER(Code) Localisation of messages allocationSize protected int allocationSize(Code) Allocation size initialValue protected int initialValue(Code) Initial value (of the first id). name protected String name(Code) Symbolic name for the sequence. poidBlock protected PoidBlock poidBlock(Code) The current block of ids that have been reserved. properties protected Properties properties(Code) Properties controlling the generator behaviour. Constructor Detail AbstractPoidGenerator public AbstractPoidGenerator(String name, Properties props)(Code) Constructor. JPOX Core will pass the following properties (as a minimum) through this constructor. class-name : Name of the class whose object is being inserted. root-class-name : Name of the root class in this inheritance tree field-name : Name of the field with the strategy (unless datastore identity field) catalog-name : Catalog of the table (if specified) schema-name : Schema of the table (if specified) table-name : Name of the root table for this inheritance tree (containing the field). column-name : Name of the column in the table (for the field) sequence-name : Name of the sequence (if specified in MetaData as "sequence) Parameters:   name - Symbolic name for this generator Parameters:   props - Properties controlling the behaviour of the generator (or null if not required). Method Detail allocate public synchronized void allocate(int additional)(Code) Method to allocate a number of values into the block. If the block already exists and has remaining values, the additional values are added to the block. Parameters:   additional - The number to allocate createRepository protected boolean createRepository()(Code) Method to create any needed repository for the ids. AbstractPoidGenerator just returns true and should be overridden by any implementing generator requiring its own repository. If all is ready for use current public synchronized Object current()(Code) Accessor for the current value allocated. Returns null if none are allocated The current value currentValue public long currentValue()(Code) Accessor for the current element in the sequence as a long. The current element throws:   JPOXDataStoreException - Thrown if not numeric getName public String getName()(Code) Accessor for the symbolic name for this generator. Symbolic name for the generator. getStorageClass public static Class getStorageClass()(Code) Accessor for the storage class for POIDs generated with this generator. Storage class (e.g Long.class) next public synchronized Object next()(Code) Get next value from the reserved block of values. The next value nextValue public long nextValue()(Code) Accessor for the next element in the sequence as a long. The next element throws:   JPOXDataStoreException - Thrown if not numeric obtainPoidBlock protected PoidBlock obtainPoidBlock()(Code) Get a new PoidBlock with the default number of ids. the PoidBlock obtainPoidBlock protected PoidBlock obtainPoidBlock(int number)(Code) Get a new PoidBlock with the specified number of ids. Parameters:   number - The number of additional ids required the PoidBlock requiresRepository protected boolean requiresRepository()(Code) Indicator for whether the generator requires its own repository. AbstractPoidGenerator returns false and this should be overridden by all generators requiring a repository. Whether a repository is required. reserveBlock protected PoidBlock reserveBlock()(Code) Method to reserve a default sized block of identities. The reserved block reserveBlock abstract protected PoidBlock reserveBlock(long size)(Code) Method to reserve a blobk of "size" ids. Parameters:   size - Number of ids to reserve The allocated block Methods inherited from java.lang.Object native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc) public boolean equals(Object obj)(Code)(Java Doc) protected void finalize() throws Throwable(Code)(Java Doc) final native public Class getClass()(Code)(Java Doc) native public int hashCode()(Code)(Java Doc) final native public void notify()(Code)(Java Doc) final native public void notifyAll()(Code)(Java Doc) public String toString()(Code)(Java Doc) final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc) final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc) final public void wait() throws InterruptedException(Code)(Java Doc)