net.sf.mpxj.primavera.common.TableDefinition Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mpxj Show documentation

Library that provides facilities to allow project information to be manipulated in Java and .Net. Supports a range of data formats: Microsoft Project Exchange (MPX), Microsoft Project (MPP,MPT), Microsoft Project Data Interchange (MSPDI XML), Microsoft Project Database (MPD), Planner (XML), Primavera (PM XML, XER, and database), Asta Powerproject (PP, MDB), Asta Easyplan (PP), Phoenix Project Manager (PPX), FastTrack Schedule (FTS), and the Standard Data Exchange Format (SDEF).

There is a newer version: 13.6.0

Show newest version

/*
 * file:       TableDefinition.java
 * author:     Jon Iles
 * copyright:  (c) Packwood Software 2018
 * date:       01/03/2018
 */

/*
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation; either version 2.1 of the License, or (at your
 * option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
 */

package net.sf.mpxj.primavera.common;

/**
 * Represents the structure of a P3 or SureTrak table.
 */
public class TableDefinition
{
   /**
    * Constructor.
    *
    * @param pageSize page size in bytes
    * @param recordSize record size in bytes
    * @param columns list of column definitions
    */
   public TableDefinition(int pageSize, int recordSize, ColumnDefinition... columns)
   {
      this(pageSize, recordSize, null, null, columns);
   }

   /**
    * Constructor.
    *
    * @param pageSize page size in bytes
    * @param recordSize record size in bytes
    * @param primaryKeyColumnName optional primary key column name
    * @param rowValidator optional row validation
    * @param columns list of column definitions
    */
   public TableDefinition(int pageSize, int recordSize, String primaryKeyColumnName, RowValidator rowValidator, ColumnDefinition... columns)
   {
      m_pageSize = pageSize;
      m_recordSize = recordSize;
      m_primaryKeyColumnName = primaryKeyColumnName;
      m_rowValidator = rowValidator;
      m_columns = columns;
   }

   /**
    * Retrieve the page size.
    *
    * @return page size in bytes
    */
   public int getPageSize()
   {
      return m_pageSize;
   }

   /**
    * Retrieve the record size.
    *
    * @return record size in bytes
    */
   public int getRecordSize()
   {
      return m_recordSize;
   }

   /**
    * Retrieve the optional primary key column name.
    *
    * @return primary key column name or null
    */
   public String getPrimaryKeyColumnName()
   {
      return m_primaryKeyColumnName;
   }

   /**
    * Retrieve the optional row validator.
    *
    * @return RowValidator instance or null
    */
   public RowValidator getRowValidator()
   {
      return m_rowValidator;
   }

   /**
    * Retrieve the column definitions.
    *
    * @return array of column definitions
    */
   public ColumnDefinition[] getColumns()
   {
      return m_columns;
   }

   private final int m_pageSize;
   private final int m_recordSize;
   private final String m_primaryKeyColumnName;
   private final RowValidator m_rowValidator;
   private final ColumnDefinition[] m_columns;
}