// Do not edit this file!  It was generated by Melati POEM's DSD preprocessor.

 package org.paneris.bibliomania.generated;

 import java.util.Collections;

 import java.util.Enumeration;

 import java.util.List;

 import org.melati.poem.AccessPoemException;

 import org.melati.poem.CachedSelection;

 import org.melati.poem.Column;

 import org.melati.poem.Field;

 import org.melati.poem.JdbcPersistent;

 import org.melati.poem.ValidationPoemException;

 import org.melati.poem.util.EmptyEnumeration;

 import org.paneris.bibliomania.BibliomaniaDatabaseTables;

 import org.paneris.bibliomania.BookFormat;

 import org.paneris.bibliomania.BookFormatTable;

 import org.paneris.bibliomania.BookStocking;

 import org.paneris.bibliomania.Product;

 /**

  * Melati POEM generated abstract base class for a <code>Persistent</code> 

  * <code>BookFormat</code> Object.

  *

  * see org.melati.poem.prepro.TableDef#generatePersistentBaseJava 

  */

 public abstract class BookFormatBase extends JdbcPersistent {

  /**

   * Retrieves the Database object.

   * 

   * see org.melati.poem.prepro.TableDef#generatePersistentBaseJava 

   * @return the database

   */

   public BibliomaniaDatabaseTables getBibliomaniaDatabaseTables() {

     return (BibliomaniaDatabaseTables)getDatabase();

   }

  /**

   * Retrieves the  <code>BookFormatTable</code> table 

   * which this <code>Persistent</code> is from.

   * 

   * see org.melati.poem.prepro.TableDef#generatePersistentBaseJava 

   * @return the BookFormatTable

   */

   @SuppressWarnings("unchecked")

   public BookFormatTable<BookFormat> getBookFormatTable() {

     return (BookFormatTable<BookFormat>)getTable();

   }

   @SuppressWarnings("unchecked")

   private BookFormatTable<BookFormat> _getBookFormatTable() {

     return (BookFormatTable<BookFormat>)getTable();

   }

   // Fields in this table 

  /**

   * id 

   */

   protected Integer id;

  /**

   * Display name - A name for the format 

   */

   protected String displayname;

  /**

   * Description regexp - A regular expression pattern for matching the 

   * different ways bookshops describe the format 

   */

   protected String descriptionregexp;

  /**

   * Retrieves the <code>Id</code> value, without locking, 

   * for this <code>BookFormat</code> <code>Persistent</code>.

   *

   * see org.melati.poem.prepro.FieldDef#generateBaseMethods 

   * @return the Integer id

   */

   public Integer getId_unsafe() {

     return id;

   }

  /**

   * Sets the <code>Id</code> value directly, without checking, 

   * for this BookFormat <code>Persistent</code>.

   * 

   * see org.melati.poem.prepro.FieldDef#generateBaseMethods 

   * @param cooked  the pre-validated value to set

   */

   public void setId_unsafe(Integer cooked) {

     id = cooked;

   }

  /**

   * Retrieves the Id value, with locking, for this 

   * <code>BookFormat</code> <code>Persistent</code>.

   * 

   * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods 

   * @throws AccessPoemException 

   *         if the current <code>AccessToken</code> 

   *         does not confer write access rights 

   * @return the value of the field <code>Id</code> for this 

   *         <code>BookFormat</code> <code>Persistent</code>  

   */

   public Integer getId()

       throws AccessPoemException {

     readLock();

     return getId_unsafe();

   }

  /**

   * Sets the <code>Id</code> value, with checking, for this 

   * <code>BookFormat</code> <code>Persistent</code>.

   * 

   * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods  

   * @param cooked  a validated <code>int</code> 

   * @throws AccessPoemException 

   *         if the current <code>AccessToken</code> 

   *         does not confer write access rights

   * @throws ValidationPoemException 

   *         if the value is not valid

   */

   public void setId(Integer cooked)

       throws AccessPoemException, ValidationPoemException {

     _getBookFormatTable().getIdColumn().

       getType().assertValidCooked(cooked);

     writeLock();

     setId_unsafe(cooked);

   }

  /**

   * Sets the <code>Id</code> value, with checking, for this 

   * <code>BookFormat</code> <code>Persistent</code>.

   * 

   * Generated by org.melati.poem.prepro.IntegerFieldDef#generateBaseMethods 

   * @param cooked  a validated <code>int</code>

   * @throws AccessPoemException 

   *         if the current <code>AccessToken</code> 

   *         does not confer write access rights

   * @throws ValidationPoemException 

   *         if the value is not valid

   */

   public final void setId(int cooked)

       throws AccessPoemException, ValidationPoemException {

     setId(new Integer(cooked));

   }

  /**

   * Retrieves the <code>Id</code> value as a <code>Field</code>

   * from this <code>BookFormat</code> <code>Persistent</code>.

   * 

   * see org.melati.poem.prepro.FieldDef#generateFieldCreator 

   * @throws AccessPoemException 

   *         if the current <code>AccessToken</code> 

   *         does not confer write access rights

   * @return the Integer id

   */

   public Field<Integer> getIdField() throws AccessPoemException {

     Column<Integer> c = _getBookFormatTable().getIdColumn();

     return new Field<Integer>((Integer)c.getRaw(this), c);

   }

  /**

   * Retrieves the <code>Displayname</code> value, without locking, 

   * for this <code>BookFormat</code> <code>Persistent</code>.

   *

   * see org.melati.poem.prepro.FieldDef#generateBaseMethods 

   * @return the String displayname

   */

   public String getDisplayname_unsafe() {

     return displayname;

   }

  /**

   * Sets the <code>Displayname</code> value directly, without checking, 

   * for this BookFormat <code>Persistent</code>.

   * 

   * see org.melati.poem.prepro.FieldDef#generateBaseMethods 

   * @param cooked  the pre-validated value to set

   */

   public void setDisplayname_unsafe(String cooked) {

     displayname = cooked;

   }

  /**

   * Retrieves the Displayname value, with locking, for this 

   * <code>BookFormat</code> <code>Persistent</code>.

   * Field description: 

   *   A name for the format 

   * 

   * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods 

   * @throws AccessPoemException 

   *         if the current <code>AccessToken</code> 

   *         does not confer write access rights 

   * @return the value of the field <code>Displayname</code> for this 

   *         <code>BookFormat</code> <code>Persistent</code>  

   */

   public String getDisplayname()

       throws AccessPoemException {

     readLock();

     return getDisplayname_unsafe();

   }

  /**

   * Sets the <code>Displayname</code> value, with checking, for this 

   * <code>BookFormat</code> <code>Persistent</code>.

   * Field description: 

   *   A name for the format 

   * 

   * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods  

   * @param cooked  a validated <code>int</code> 

   * @throws AccessPoemException 

   *         if the current <code>AccessToken</code> 

   *         does not confer write access rights

   * @throws ValidationPoemException 

   *         if the value is not valid

   */

   public void setDisplayname(String cooked)

       throws AccessPoemException, ValidationPoemException {

     _getBookFormatTable().getDisplaynameColumn().

       getType().assertValidCooked(cooked);

     writeLock();

     setDisplayname_unsafe(cooked);

   }

  /**

   * Retrieves the <code>Displayname</code> value as a <code>Field</code>

   * from this <code>BookFormat</code> <code>Persistent</code>.

   * 

   * see org.melati.poem.prepro.FieldDef#generateFieldCreator 

   * @throws AccessPoemException 

   *         if the current <code>AccessToken</code> 

   *         does not confer write access rights

   * @return the String displayname

   */

   public Field<String> getDisplaynameField() throws AccessPoemException {

     Column<String> c = _getBookFormatTable().getDisplaynameColumn();

     return new Field<String>((String)c.getRaw(this), c);

   }

  /**

   * Retrieves the <code>Descriptionregexp</code> value, without locking, 

   * for this <code>BookFormat</code> <code>Persistent</code>.

   *

   * see org.melati.poem.prepro.FieldDef#generateBaseMethods 

   * @return the String descriptionregexp

   */

   public String getDescriptionregexp_unsafe() {

     return descriptionregexp;

   }

  /**

   * Sets the <code>Descriptionregexp</code> value directly, without checking, 

   * for this BookFormat <code>Persistent</code>.

   * 

   * see org.melati.poem.prepro.FieldDef#generateBaseMethods 

   * @param cooked  the pre-validated value to set

   */

   public void setDescriptionregexp_unsafe(String cooked) {

     descriptionregexp = cooked;

   }

  /**

   * Retrieves the Descriptionregexp value, with locking, for this 

   * <code>BookFormat</code> <code>Persistent</code>.

   * Field description: 

   *   A regular expression pattern for matching the different ways bookshops 

   *   describe the format 

   * 

   * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods 

   * @throws AccessPoemException 

   *         if the current <code>AccessToken</code> 

   *         does not confer write access rights 

   * @return the value of the field <code>Descriptionregexp</code> for this 

   *         <code>BookFormat</code> <code>Persistent</code>  

   */

   public String getDescriptionregexp()

       throws AccessPoemException {

     readLock();

     return getDescriptionregexp_unsafe();

   }

  /**

   * Sets the <code>Descriptionregexp</code> value, with checking, for this 

   * <code>BookFormat</code> <code>Persistent</code>.

   * Field description: 

   *   A regular expression pattern for matching the different ways bookshops 

   *   describe the format 

   * 

   * Generated by org.melati.poem.prepro.AtomFieldDef#generateBaseMethods  

   * @param cooked  a validated <code>int</code> 

   * @throws AccessPoemException 

   *         if the current <code>AccessToken</code> 

   *         does not confer write access rights

   * @throws ValidationPoemException 

   *         if the value is not valid

   */

   public void setDescriptionregexp(String cooked)

       throws AccessPoemException, ValidationPoemException {

     _getBookFormatTable().getDescriptionregexpColumn().

       getType().assertValidCooked(cooked);

     writeLock();

     setDescriptionregexp_unsafe(cooked);

   }

  /**

   * Retrieves the <code>Descriptionregexp</code> value as a <code>Field</code>

   * from this <code>BookFormat</code> <code>Persistent</code>.

   * 

   * see org.melati.poem.prepro.FieldDef#generateFieldCreator 

   * @throws AccessPoemException 

   *         if the current <code>AccessToken</code> 

   *         does not confer write access rights

   * @return the String descriptionregexp

   */

   public Field<String> getDescriptionregexpField() throws AccessPoemException {

     Column<String> c = _getBookFormatTable().getDescriptionregexpColumn();

     return new Field<String>((String)c.getRaw(this), c);

   }

   private CachedSelection<Product> formatProducts = null;

   /** References to this BookFormat in the Product table via its format field.*/

   @SuppressWarnings("unchecked")

   public Enumeration<Product> getFormatProducts() {

     if (getTroid() == null)

       return new EmptyEnumeration<Product>();

     else {

       if (formatProducts == null)

         formatProducts =

           getBibliomaniaDatabaseTables().getProductTable().getFormatColumn().cachedSelectionWhereEq(getTroid());

       return formatProducts.objects();

     }

   }

   /** References to this BookFormat in the Product table via its format field, as a List.*/

   public List<Product> getFormatProductList() {

     return Collections.list(getFormatProducts());

   }

   private CachedSelection<BookStocking> formatcodeBookStockings = null;

   /** References to this BookFormat in the BookStocking table via its formatcode field.*/

   @SuppressWarnings("unchecked")

   public Enumeration<BookStocking> getFormatcodeBookStockings() {

     if (getTroid() == null)

       return new EmptyEnumeration<BookStocking>();

     else {

       if (formatcodeBookStockings == null)

         formatcodeBookStockings =

           getBibliomaniaDatabaseTables().getBookStockingTable().getFormatcodeColumn().cachedSelectionWhereEq(getTroid());

       return formatcodeBookStockings.objects();

     }

   }

   /** References to this BookFormat in the BookStocking table via its formatcode field, as a List.*/

   public List<BookStocking> getFormatcodeBookStockingList() {

     return Collections.list(getFormatcodeBookStockings());

   }

 }