org.compiere.model.MUOMConversion

All Implemented Interfaces:: Serializable, Cloneable, Comparator<Object>, I_C_UOM_Conversion, I_Persistent, Evaluatee, ImmutablePOSupport

public class MUOMConversion extends X_C_UOM_Conversion implements ImmutablePOSupport

Unit of Measure Conversion Model

Version:

$Id: MUOMConversion.java,v 1.3 2006/07/30 00:51:03 jjanke Exp $

Author:

Jorg Janke

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type

Field

Description

protected static final BigDecimal

GETRATE

Indicator for Rate

protected static final CCache<Integer,MUOMConversion[]>

s_conversionProduct

Product Conversion Map

protected static CCache<Point,BigDecimal>

s_conversions

Conversion Map: Key=Point(from,to) Value=BigDecimal

Fields inherited from class org.compiere.model.PO
ACCESSLEVEL_ALL, ACCESSLEVEL_CLIENT, ACCESSLEVEL_CLIENTORG, ACCESSLEVEL_ORG, ACCESSLEVEL_SYSTEM, ACCESSLEVEL_SYSTEMCLIENT, ENTITYTYPE_Dictionary, ENTITYTYPE_UserMaintained, I_ZERO, LOCAL_TRX_PREFIX, log, p_ctx, p_info, UUID_NEW_RECORD, XML_ATTRIBUTE_AD_Table_ID, XML_ATTRIBUTE_Record_ID

Fields inherited from interface org.compiere.model.I_C_UOM_Conversion
accessLevel, COLUMNNAME_AD_Client_ID, COLUMNNAME_AD_Org_ID, COLUMNNAME_C_UOM_Conversion_ID, COLUMNNAME_C_UOM_Conversion_UU, COLUMNNAME_C_UOM_ID, COLUMNNAME_C_UOM_To_ID, COLUMNNAME_Created, COLUMNNAME_CreatedBy, COLUMNNAME_DivideRate, COLUMNNAME_IsActive, COLUMNNAME_M_Product_ID, COLUMNNAME_MultiplyRate, COLUMNNAME_Updated, COLUMNNAME_UpdatedBy, Model, Table_ID, Table_Name
Constructor Summary

Constructors

Constructor

Description

MUOMConversion(Properties ctx, int C_UOM_Conversion_ID, String trxName)

Default Constructor

MUOMConversion(Properties ctx, String C_UOM_Conversion_UU, String trxName)

UUID based Constructor

MUOMConversion(Properties ctx, ResultSet rs, String trxName)

Load Constructor

MUOMConversion(Properties ctx, MUOMConversion copy)

MUOMConversion(Properties ctx, MUOMConversion copy, String trxName)

MUOMConversion(MProduct parent)

Parent Constructor

MUOMConversion(MUOM parent)

Parent Constructor

MUOMConversion(MUOMConversion copy)
Method Summary

Modifier and Type

Method

Description

protected boolean

beforeSave(boolean newRecord)

Before Save

static BigDecimal

convert(int C_UOM_From_ID, int C_UOM_To_ID, BigDecimal qty, boolean StdPrecision)

Get Converted Qty from Server (no cache)

static BigDecimal

convert(Properties ctx, int C_UOM_ID, int C_UOM_To_ID, BigDecimal qty)

Convert qty to target UOM and round.

static BigDecimal

convertProductFrom(Properties ctx, int M_Product_ID, int C_UOM_To_ID, BigDecimal qtyPrice)

Convert PRICE expressed in product UoM to equivalent price in entered UoM and round.

static BigDecimal

convertProductFrom(Properties ctx, int M_Product_ID, int C_UOM_To_ID, BigDecimal qtyPrice, int precision)

Convert PRICE expressed in product UoM to equivalent price in entered UoM and round.

static BigDecimal

convertProductTo(Properties ctx, int M_Product_ID, int C_UOM_To_ID, BigDecimal qtyPrice)

Convert PRICE expressed in entered UoM to equivalent price in product UoM and round.

static BigDecimal

convertProductTo(Properties ctx, int M_Product_ID, int C_UOM_To_ID, BigDecimal qtyPrice, int precision)

Convert PRICE expressed in entered UoM to equivalent price in product UoM and round.

static int

convertToMinutes(Properties ctx, int C_UOM_ID, BigDecimal qty)

Convert qty to target UOM and round.

protected static void

createRates(Properties ctx)

Create Conversion Matrix (Client)

static BigDecimal

deriveRate(Properties ctx, int C_UOM_ID, int C_UOM_To_ID)

Derive Standard Conversions

static Timestamp

getEndDate(Properties ctx, Timestamp startDate, int C_UOM_ID, BigDecimal qty)

Calculate End Date based on start date and qty

static BigDecimal

getOppositeRate(BigDecimal rate)

Calculate opposite conversion rate, i.e calculate divide rate for multiply rate and vice versa.

static BigDecimal

getOppositeRate(BigDecimal rate, int scale)

Calculate opposite conversion rate, i.e calculate divide rate for multiply rate and vice versa.

static MUOMConversion[]

getProductConversions(Properties ctx, int M_Product_ID)

Get Product Conversions (cached)

static BigDecimal

getProductRateFrom(Properties ctx, int M_Product_ID, int C_UOM_To_ID)

Get multiply rate to convert PRICE from price in entered UOM to price in product UOM
OR multiply rate to convert QTY from product UOM to entered UOM

static BigDecimal

getProductRateTo(Properties ctx, int M_Product_ID, int C_UOM_To_ID)

Get multiply rate to convert PRICE from price in entered UOM to price in product UOM
OR multiply rate to convert QTY from product UOM to entered UOM

static BigDecimal

getRate(int C_UOM_ID, int C_UOM_To_ID)

Get Conversion Multiplier Rate from Server

static BigDecimal

getRate(Properties ctx, int C_UOM_ID, int C_UOM_To_ID)

Get Multiplier Rate to target UOM

protected static BigDecimal

getRate(Properties ctx, Point p)

Get Conversion Multiplier Rate, try to derive it if not found directly

MUOMConversion

markImmutable()

mark PO as immutable

String

toString()

String Representation

Methods inherited from class org.compiere.model.X_C_UOM_Conversion
get_AccessLevel, getC_UOM, getC_UOM_Conversion_ID, getC_UOM_Conversion_UU, getC_UOM_ID, getC_UOM_To, getC_UOM_To_ID, getDivideRate, getKeyNamePair, getM_Product, getM_Product_ID, getMultiplyRate, initPO, setC_UOM_Conversion_ID, setC_UOM_Conversion_UU, setC_UOM_ID, setC_UOM_To_ID, setDivideRate, setM_Product_ID, setMultiplyRate

Methods inherited from class org.compiere.model.PO
afterDelete, afterSave, beforeDelete, buildInsertSQL, checkImmutable, clearCrossTenantSafe, clone, columnExists, columnExists, compare, copyPO, copyValues, copyValues, createAttachment, delete, delete, delete_Accounting, delete_Tree, deleteEx, deleteEx, dump, dump, equals, get_Attribute, get_Attributes, get_ColumnCount, get_ColumnDescription, get_ColumnDisplayType, get_ColumnIndex, get_ColumnLabel, get_ColumnLookup, get_ColumnName, get_DisplayValue, get_HashMap, get_ID, get_IDOld, get_KeyColumns, get_Logger, get_OptimisticLockingColumns, get_Table_ID, get_TableName, get_Translation, get_Translation, get_Translation, get_Translation, get_Translation, get_TrxName, get_UUID, get_Value, get_Value, get_ValueAsBoolean, get_ValueAsInt, get_ValueAsInt, get_ValueAsString, get_ValueAsString, get_ValueDifference, get_ValueDifference, get_ValueE, get_ValueOfColumn, get_ValueOld, get_ValueOld, get_ValueOldAsInt, get_WhereClause, get_WhereClause, get_xmlDocument, get_xmlString, getAD_Client_ID, getAD_Org_ID, getAllIDs, getAttachment, getAttachment, getAttachmentData, getCreated, getCreatedBy, getCtx, getDoc, getFindParameter, getPdfAttachment, getUpdated, getUpdatedBy, getUUIDColumnName, getUUIDColumnName, hashCode, insert_Accounting, insert_Tree, insert_Tree, is_Changed, is_Immutable, is_new, is_UseOptimisticLocking, is_ValueChanged, is_ValueChanged, isActive, isAttachment, isColumnMandatory, isColumnUpdateable, isMandatoryOK, isPdfAttachment, isReplication, load, load, load, load, loadByUU, loadComplete, loadDefaults, loadPO, loadSpecial, lock, makeImmutable, postDelete, retrieveIdOfParentValue, retrieveIdOfParentValue, save, save, saveCrossTenantSafe, saveCrossTenantSafeEx, saveCrossTenantSafeEx, saveEx, saveEx, saveNew_afterSetID, saveNew_getID, saveNewSpecial, saveReplica, saveUpdate, set_Attribute, set_ColumnUpdateable, set_CustomColumn, set_CustomColumnReturningBoolean, set_OptimisticLockingColumns, set_TrxName, set_TrxName, set_UseOptimisticLocking, set_Value, set_Value, set_Value, set_Value, set_ValueE, set_ValueNoCheck, set_ValueNoCheckE, set_ValueOfColumn, set_ValueOfColumn, set_ValueOfColumnReturningBoolean, set_ValueOfColumnReturningBoolean, setAD_Client_ID, setAD_Org_ID, setClientOrg, setClientOrg, setCrossTenantSafe, setDoc, setDocWorkflowMgr, setIsActive, setProcessedOn, setReplication, setStandardDefaults, setUpdateable, setUpdatedBy, toInsertSQL, unlock, update_Tree, validForeignKeys

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Comparator
reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Methods inherited from interface org.compiere.model.I_C_UOM_Conversion
getAD_Client_ID, getAD_Org_ID, getCreated, getCreatedBy, getUpdated, getUpdatedBy, isActive, setAD_Org_ID, setIsActive

Methods inherited from interface org.compiere.model.I_Persistent
save

Field Details
- GETRATE
  
  protected static final BigDecimal GETRATE
  
  Indicator for Rate
- s_conversions
  
  protected static CCache<Point,BigDecimal> s_conversions
  
  Conversion Map: Key=Point(from,to) Value=BigDecimal
- s_conversionProduct
  
  protected static final CCache<Integer,MUOMConversion[]> s_conversionProduct
  
  Product Conversion Map
Constructor Details
- MUOMConversion
  
  public MUOMConversion(Properties ctx, String C_UOM_Conversion_UU, String trxName)
  
  UUID based Constructor
  
  Parameters:
  
  ctx - Context
  
  C_UOM_Conversion_UU - UUID key
  
  trxName - Transaction
- MUOMConversion
  
  public MUOMConversion(Properties ctx, int C_UOM_Conversion_ID, String trxName)
  
  Default Constructor
  
  Parameters:
  
  ctx - context
  
  C_UOM_Conversion_ID - id
  
  trxName - transaction
- MUOMConversion
  
  public MUOMConversion(Properties ctx, ResultSet rs, String trxName)
  
  Load Constructor
  
  Parameters:
  
  ctx - context
  
  rs - result set
  
  trxName - transaction
- MUOMConversion
  
  public MUOMConversion(MUOM parent)
  
  Parent Constructor
  
  Parameters:
  
  parent - uom parent
- MUOMConversion
  
  public MUOMConversion(MProduct parent)
  
  Parent Constructor
  
  Parameters:
  
  parent - product parent
- MUOMConversion
  
  public MUOMConversion(MUOMConversion copy)
  
  Parameters:
  
  copy -
- MUOMConversion
  
  public MUOMConversion(Properties ctx, MUOMConversion copy)
  
  Parameters:
  
  ctx -
  
  copy -
- MUOMConversion
  
  public MUOMConversion(Properties ctx, MUOMConversion copy, String trxName)
  
  Parameters:
  
  ctx -
  
  copy -
  
  trxName -
Method Details
- convert
  
  public static BigDecimal convert(Properties ctx, int C_UOM_ID, int C_UOM_To_ID, BigDecimal qty)
  
  Convert qty to target UOM and round.
  
  Parameters:
  
  ctx - context
  
  C_UOM_ID - from UOM
  
  C_UOM_To_ID - to UOM
  
  qty - qty
  
  Returns:
  
  converted qty (std precision)
- getRate
  
  public static BigDecimal getRate(Properties ctx, int C_UOM_ID, int C_UOM_To_ID)
  
  Get Multiplier Rate to target UOM
  
  Parameters:
  
  ctx - context
  
  C_UOM_ID - from UOM
  
  C_UOM_To_ID - to UOM
  
  Returns:
  
  multiplier
- convertToMinutes
  
  public static int convertToMinutes(Properties ctx, int C_UOM_ID, BigDecimal qty)
  
  Convert qty to target UOM and round.
  
  Parameters:
  
  ctx - context
  
  C_UOM_ID - from UOM
  
  qty - qty
  
  Returns:
  
  minutes - 0 if not found
- getEndDate
  
  public static Timestamp getEndDate(Properties ctx, Timestamp startDate, int C_UOM_ID, BigDecimal qty)
  
  Calculate End Date based on start date and qty
  
  Parameters:
  
  ctx - context
  
  startDate - date
  
  C_UOM_ID - UOM
  
  qty - qty
  
  Returns:
  
  end date
- getRate
  
  protected static BigDecimal getRate(Properties ctx, Point p)
  
  Get Conversion Multiplier Rate, try to derive it if not found directly
  
  Parameters:
  
  ctx - context
  
  p - Point with from(x) - to(y) C_UOM_ID
  
  Returns:
  
  conversion multiplier or null
- createRates
  
  protected static void createRates(Properties ctx)
  
  Create Conversion Matrix (Client)
  
  Parameters:
  
  ctx - context
- deriveRate
  
  public static BigDecimal deriveRate(Properties ctx, int C_UOM_ID, int C_UOM_To_ID)
  
  Derive Standard Conversions
  
  Parameters:
  
  ctx - context
  
  C_UOM_ID - from UOM
  
  C_UOM_To_ID - to UOM
  
  Returns:
  
  Conversion or null
- getRate
  
  public static BigDecimal getRate(int C_UOM_ID, int C_UOM_To_ID)
  
  Get Conversion Multiplier Rate from Server
  
  Parameters:
  
  C_UOM_ID - from UOM
  
  C_UOM_To_ID - to UOM
  
  Returns:
  
  conversion multiplier or null
- convert
  
  public static BigDecimal convert(int C_UOM_From_ID, int C_UOM_To_ID, BigDecimal qty, boolean StdPrecision)
  
  Get Converted Qty from Server (no cache)
  
  Parameters:
  
  qty - The quantity to be converted
  
  C_UOM_From_ID - The C_UOM_ID of the qty
  
  C_UOM_To_ID - The targeted UOM
  
  StdPrecision - if true, standard precision, if false costing precision
  
  Returns:
  
  amount
- convertProductTo
  
  public static BigDecimal convertProductTo(Properties ctx, int M_Product_ID, int C_UOM_To_ID, BigDecimal qtyPrice)
  
  Convert PRICE expressed in entered UoM to equivalent price in product UoM and round.
  OR Convert QTY in product UOM to qty in entered UoM and round.
  eg: $6/6pk => $1/ea
  OR 6 X ea => 1 X 6pk
  
  Parameters:
  
  ctx - context
  
  M_Product_ID - product
  
  C_UOM_To_ID - entered UOM
  
  qtyPrice - quantity or price
  
  Returns:
  
  Product: Qty/Price (precision rounded)
- convertProductTo
  
  public static BigDecimal convertProductTo(Properties ctx, int M_Product_ID, int C_UOM_To_ID, BigDecimal qtyPrice, int precision)
  
  Convert PRICE expressed in entered UoM to equivalent price in product UoM and round.
  OR Convert QTY in product UOM to qty in entered UoM and round.
  eg: $6/6pk => $1/ea
  OR 6 X ea => 1 X 6pk
  
  Parameters:
  
  ctx - context
  
  M_Product_ID - product
  
  C_UOM_To_ID - entered UOM
  
  qtyPrice - quantity or price
  
  precision - Rounding precision, -1 to use precision from UOM
  
  Returns:
  
  Product: Qty/Price (precision rounded)
- getProductRateTo
  
  public static BigDecimal getProductRateTo(Properties ctx, int M_Product_ID, int C_UOM_To_ID)
  
  Get multiply rate to convert PRICE from price in entered UOM to price in product UOM
  OR multiply rate to convert QTY from product UOM to entered UOM
  
  Parameters:
  
  ctx - context
  
  M_Product_ID - product
  
  C_UOM_To_ID - entered UOM
  
  Returns:
  
  multiplier or null
- convertProductFrom
  
  public static BigDecimal convertProductFrom(Properties ctx, int M_Product_ID, int C_UOM_To_ID, BigDecimal qtyPrice)
  
  Convert PRICE expressed in product UoM to equivalent price in entered UoM and round.
  OR Convert QTY in entered UOM to qty in product UoM and round.
  eg: $1/ea => $6/6pk
  OR 1 X 6pk => 6 X ea
  
  Parameters:
  
  ctx - context
  
  M_Product_ID - product
  
  C_UOM_To_ID - entered UOM
  
  qtyPrice - quantity or price
  
  Returns:
  
  Product: Qty/Price (precision rounded)
- convertProductFrom
  
  public static BigDecimal convertProductFrom(Properties ctx, int M_Product_ID, int C_UOM_To_ID, BigDecimal qtyPrice, int precision)
  
  Convert PRICE expressed in product UoM to equivalent price in entered UoM and round.
  OR Convert QTY in entered UOM to qty in product UoM and round.
  eg: $1/ea => $6/6pk
  OR 1 X 6pk => 6 X ea
  
  Parameters:
  
  ctx - context
  
  M_Product_ID - product
  
  C_UOM_To_ID - entered UOM
  
  qtyPrice - quantity or price
  
  precision - Rounding precision, -1 to use precision from UOM
  
  Returns:
  
  Product: Qty/Price (precision rounded)
- getProductRateFrom
  
  public static BigDecimal getProductRateFrom(Properties ctx, int M_Product_ID, int C_UOM_To_ID)
  
  Get multiply rate to convert PRICE from price in entered UOM to price in product UOM
  OR multiply rate to convert QTY from product UOM to entered UOM
  
  Parameters:
  
  ctx - context
  
  M_Product_ID - product
  
  C_UOM_To_ID - entered UOM
  
  Returns:
  
  multiplier or null
- getProductConversions
  
  public static MUOMConversion[] getProductConversions(Properties ctx, int M_Product_ID)
  
  Get Product Conversions (cached)
  
  Parameters:
  
  ctx - context
  
  M_Product_ID - product
  
  Returns:
  
  array of conversions
- beforeSave
  
  protected boolean beforeSave(boolean newRecord)
  
  Before Save
  
  Overrides:
  
  beforeSave in class PO
  
  Parameters:
  
  newRecord - new
  
  Returns:
  
  true if can be saved
- toString
  
  public String toString()
  
  String Representation
  
  Overrides:
  
  toString in class X_C_UOM_Conversion
  
  Returns:
  
  info
- markImmutable
  
  public MUOMConversion markImmutable()
  
  Description copied from interface: ImmutablePOSupport
  
  mark PO as immutable
  
  Specified by:
  
  markImmutable in interface ImmutablePOSupport
  
  Returns:
  
  PO
- getOppositeRate
  
  public static BigDecimal getOppositeRate(BigDecimal rate)
  
  Calculate opposite conversion rate, i.e calculate divide rate for multiply rate and vice versa.
  
  Parameters:
  
  rate -
  
  Returns:
  
  BigDecimal
- getOppositeRate
  
  public static BigDecimal getOppositeRate(BigDecimal rate, int scale)
  
  Calculate opposite conversion rate, i.e calculate divide rate for multiply rate and vice versa.
  
  Parameters:
  
  rate -
  
  Returns:
  
  BigDecimal

Class MUOMConversion

Field Summary

Fields inherited from class org.compiere.model.PO

Fields inherited from interface org.compiere.model.I_C_UOM_Conversion

Constructor Summary

Method Summary

Methods inherited from class org.compiere.model.X_C_UOM_Conversion

Methods inherited from class org.compiere.model.PO

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Comparator

Methods inherited from interface org.compiere.model.I_C_UOM_Conversion

Methods inherited from interface org.compiere.model.I_Persistent

Field Details

GETRATE

s_conversions

s_conversionProduct

Constructor Details

MUOMConversion

MUOMConversion

MUOMConversion

MUOMConversion

MUOMConversion

MUOMConversion

MUOMConversion

MUOMConversion

Method Details

convert

getRate

convertToMinutes

getEndDate

getRate

createRates

deriveRate

getRate

convert

convertProductTo

convertProductTo

getProductRateTo

convertProductFrom

convertProductFrom

getProductRateFrom

getProductConversions

beforeSave

toString

markImmutable

getOppositeRate

getOppositeRate