/*
 * Copyright 2008 Fedora Commons
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.mulgara.sparql.parser.cst;

import java.math.BigDecimal;


/**
 * Represents a Decimal literal number.
 *
 * @created Feb 11, 2008
 * @author Paula Gearon
 * @copyright © 2008 <a href="http://www.fedora-commons.org/">Fedora Commons</a>
 * @licence <a href="{@docRoot}/../LICENCE.txt">Apache License, Version 2.0</a>
 */
public class DecimalLiteral implements NumericLiteral {

  /** The value of this literal. */
  private BigDecimal value;

  /**
   * Constructs the literal from a string image.
   * @param s The string image of the value for this literal
   */
  public DecimalLiteral(String s) {
    this.value = new BigDecimal(s);
  }

  /**
   * Constructs the literal.
   * @param value The double precision floating point value for this literal
   */
  public DecimalLiteral(double value) {
    this.value = BigDecimal.valueOf(value);
  }
  
  /**
   * Constructs the literal.
   * @param value The long integral value for this literal
   */
  public DecimalLiteral(long value) {
    this.value = BigDecimal.valueOf(value);
  }
  
  /**
   * Retrieve the value as a generic Number.
   * We deem the loss of precision to double to be acceptable
   * @return A Number object containing the value.
   */
  public Number getValue() {
    Number result = value.doubleValue();
    if (result.equals(Double.NEGATIVE_INFINITY) || result.equals(Double.POSITIVE_INFINITY)) result = value;
    return result;
  }

  /**
   * Retrieve the value as a raw type.
   * @return The internal value.
   */
  public double getDouble() {
    return value.doubleValue();
  }

  /**
   * @see org.mulgara.sparql.parser.cst.Node#getImage()
   */
  public String getImage() {
    return value.toPlainString();
  }

}