com.ibm.as400.access.PackedDecimalFieldDescription Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jt400 Show documentation
The Open Source version of the IBM Toolbox for Java
The newest version!
///////////////////////////////////////////////////////////////////////////////
//                                                                             
// JTOpen (IBM Toolbox for Java - OSS version)                              
//                                                                             
// Filename: PackedDecimalFieldDescription.java
//                                                                             
// The source code contained herein is licensed under the IBM Public License   
// Version 1.0, which has been approved by the Open Source Initiative.         
// Copyright (C) 1997-2000 International Business Machines Corporation and     
// others. All rights reserved.                                                
//                                                                             
///////////////////////////////////////////////////////////////////////////////

package com.ibm.as400.access;

import java.math.BigDecimal;
import java.io.Serializable;
import java.util.Vector;

/**
 *Represents the description of the data in a packed decimal field.
 *This class allows:
 *
 *The user to describe a packed decimal field to the RecordFormat object.
 *
The RecordFormat object to describe a packed decimal field to the user.
 *
 *Click hereto see an example.
**/
public class PackedDecimalFieldDescription extends FieldDescription implements Serializable
{
    static final long serialVersionUID = 4L;


  // Number of digits to the right of the decimal point
  private int decimalPositions_;
  /**
   *Constructs a PackedDecimalFieldDescription object. It uses the specified
   *data type and name of the field.
   *The number of digits and the number of decimal positions will be determined from
   *dataType.
   *@param dataType Describes the field and provides
   *                the conversion capability for the contents of the field.
   *@param name The name of the field.
   *
  **/
  public PackedDecimalFieldDescription(AS400PackedDecimal dataType, String name)
  {
    super(dataType, name);
    length_ = dataType.getNumberOfDigits();
    decimalPositions_ = dataType.getNumberOfDecimalPositions();
  }

  /**
   *Constructs a PackedDecimalFieldDescription object.
  **/
  public PackedDecimalFieldDescription()
  {
  }

  /**
   *Constructs a PackedDecimalFieldDescription object. It uses the specified
   *data type, name, and DDS name of the field.
   *The number of digits and the number of decimal positions will be determined from dataType.
   *@param dataType Describes the field and provides
   *                the conversion capability for the contents of the field.
   *@param name The name of the field.
   *@param ddsName The DDS name of this field. This is the
   *               name of the field as it would appear in a DDS description of the
   *               field.  The length of ddsName must be 10 characters or less.
   **/
  public PackedDecimalFieldDescription(AS400PackedDecimal dataType, String name, String ddsName)
  {
    super(dataType, name, ddsName);
    length_ = dataType.getNumberOfDigits();
    decimalPositions_ = dataType.getNumberOfDecimalPositions();
  }

  

  /**
   *Returns the DDS description for the field.  This is a string containing
   *the description of the field as it would be specified in a DDS source file.
   *This method is used by AS400File.createDDSSourceFile to specify the field
   *in the DDS source file which is used to create the file for the user who
   *has passed in a RecordFormat object.
   *@return The DDS description of this field properly formatted for entry
   *into a DDS source file.
  **/
  String[] getDDSDescription()
  {
    Vector v = new Vector();
    // Name columns (10)
    StringBuffer desc = new StringBuffer(ddsName_);
    // Blank pad the ddsName to 10 characters.
    while(desc.length() < 10)
    {
      desc.append(" ");
    }
    // Reference column (1)
    if (!refFld_.equals(""))
    {
      desc.append("R");
    }
    else
    {
      desc.append(" ");
    }
    // Get length as 5 digit string, right justified
/*    StringBuffer len = new StringBuffer(new Integer(length_).toString());
    if (len.length() < 5)
    {
      int blanksNeeded = 5 - len.length();
      for (short i = 0; i < blanksNeeded; ++i)
      {
        len.insert(0, " ");
      }
    }
*/    
    String len = String.valueOf(length_);
    int numSpaces = 5-len.length();
    for (int i=0; idataType
   *cannot be null.
  **/
  public void setDataType(AS400PackedDecimal dataType)
  {
    // Verify parameters
    if (dataType == null)
    {
      throw new NullPointerException("dataType");
    }
    dataType_ = dataType;
    length_ = dataType.getNumberOfDigits();
    decimalPositions_ = dataType.getNumberOfDecimalPositions();
  }

  //@B0C - javadoc
  /**
   *Sets the value for the DFT keyword for this field.
   *@param defaultValue The default value for this
   *                   field.  The defaultValue cannot be null.
   *To set a default value of *NULL, use the setDFTNull() method.
  **/
  public void setDFT(BigDecimal defaultValue)
  {
    if (defaultValue == null)
    {
      throw new NullPointerException("defaultValue");
    }
    defaultValue_ = defaultValue;
    isDFTNull_ = false; //@B0A
    isDFTCurrent_ = false; //@B0A
    DFTCurrentValue_ = null; //@B0A
  }

  //@B0A
  /**
   *Sets the value for the DFT keyword to be *NULL for this field.
   *Calling this method will replace the DFT keyword that was previously
   *set on a call to setDFT(). Note: This field
   *must also have its ALWNULL keyword set to true to prevent DDS errors.
  **/
  public void setDFTNull()
  {
    isDFTNull_ = true;
    defaultValue_ = null;
    isDFTCurrent_ = false;
    DFTCurrentValue_ = null;
  }
}