org.deri.iris.builtins.datatype
Class ToDecimalBuiltin

java.lang.Object
  org.deri.iris.builtins.AbstractBuiltin
      org.deri.iris.builtins.FunctionalBuiltin
          org.deri.iris.builtins.datatype.ConversionBuiltin
              org.deri.iris.builtins.datatype.ToDecimalBuiltin

All Implemented Interfaces:

Comparable<IAtom>, IAtom, IBuiltinAtom

public class ToDecimalBuiltin
extends ConversionBuiltin

Represents a data type conversion function, which converts supported data type instances to Decimal instances. The following data types are supported:

• Boolean
• Double
• Float
• Integer
• String

Field Summary

Fields inherited from class org.deri.iris.builtins.AbstractBuiltin

EMPTY_TERM

Constructor Summary

ToDecimalBuiltin(ITerm... terms)
Creates a new instance of this builtin.

Method Summary

protected ITerm	convert(ITerm term) Converts the given supported data type instance to the specific data type
static IDecimalTerm	toDecimal(IBooleanTerm term) Converts a Boolean term to a Decimal term.
static IDecimalTerm	toDecimal(IFloatTerm term) Converts a Float term to a Decimal term.
static IDecimalTerm	toDecimal(INumericTerm term) Converts a Numeric term to a Decimal term.
static IDecimalTerm	toDecimal(IStringTerm term) Converts a String term to a Decimal term.

Methods inherited from class org.deri.iris.builtins.datatype.ConversionBuiltin

computeResult

Methods inherited from class org.deri.iris.builtins.FunctionalBuiltin

evaluateTerms, maxUnknownVariables, testForEquality

Methods inherited from class org.deri.iris.builtins.AbstractBuiltin

compareTo, equals, evaluate, getPredicate, getTuple, hashCode, isBuiltin, isGround, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ToDecimalBuiltin

public ToDecimalBuiltin(ITerm... terms)

Creates a new instance of this builtin.

Parameters:

terms - The term representing the data type instance to be converted.

Method Detail

convert

protected ITerm convert(ITerm term)

Description copied from class: ConversionBuiltin

Converts the given supported data type instance to the specific data type

Specified by:

convert in class ConversionBuiltin

Returns:

The result of the conversion or null if the specified data type is not compatible.

toDecimal

public static IDecimalTerm toDecimal(IBooleanTerm term)

Converts a Boolean term to a Decimal term. A Boolean term representing the value "True" is converted to a Decimal term representing "1.0". A Boolean term representing the value "False" is converted to a Decimal term representing "0.0".

Parameters:

term - The Boolean term to be converted.

Returns:

A new Decimal term representing the result of the conversion.

toDecimal

public static IDecimalTerm toDecimal(IFloatTerm term)

Converts a Float term to a Decimal term.

Parameters:

term - The Float term to be converted.

Returns:

A new Decimal term representing the result of the conversion.

toDecimal

public static IDecimalTerm toDecimal(INumericTerm term)

Converts a Numeric term to a Decimal term.

Parameters:

term - The Float term to be converted.

Returns:

A new Decimal term representing the result of the conversion.

toDecimal

public static IDecimalTerm toDecimal(IStringTerm term)

Converts a String term to a Decimal term.

Parameters:

term - The String term to be converted.

Returns:

A new Decimal term representing the result of the conversion.