net.sf.mpxj.CustomField 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.8.0

Show newest version

/*
 * file:       CustomField.java
 * author:     Jon Iles
 * copyright:  (c) Packwood Software 2002-2015
 * date:       28/04/2015
 */

/*
 * 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;

/**
 * Configuration detail for a custom field.
 */
public class CustomField
{
   /**
    * Constructor.
    *
    * @param field field
    * @param parent parent container
    */
   public CustomField(FieldType field, CustomFieldContainer parent)
   {
      m_field = field;
      m_parent = parent;
      m_table = new CustomFieldLookupTable(m_parent);
      m_indicator = new GraphicalIndicator();
   }

   /**
    * Retrieve the field type represented by this instance.
    *
    * @return field type
    */
   public FieldType getFieldType()
   {
      return m_field;
   }

   /**
    * Retrieve the value lookup table associated with this custom field.
    *
    * @return value lookup table
    */
   public CustomFieldLookupTable getLookupTable()
   {
      return m_table;
   }

   /**
    * Retrieve the graphical indicator configuration for this custom field.
    *
    * @return graphical indicator configuration
    */
   public GraphicalIndicator getGraphicalIndicator()
   {
      return m_indicator;
   }

   /**
    * Retrieve the alias for this field.
    *
    * @return field alias
    */
   public String getAlias()
   {
      return m_alias;
   }

   /**
    * Set the alias for this field.
    *
    * @param alias field alias
    */
   public void setAlias(String alias)
   {
      m_alias = alias;
      m_parent.registerAlias(m_field, alias);
   }

   private final FieldType m_field;
   private final CustomFieldContainer m_parent;
   private final CustomFieldLookupTable m_table;
   private final GraphicalIndicator m_indicator;
   private String m_alias;
}