Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.broadleafcommerce.core.catalog.domain.SkuImpl Maven / Gradle / Ivy
/*
* Copyright 2008-2012 the original author or authors.
*
* 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.broadleafcommerce.core.catalog.domain;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.broadleafcommerce.common.money.Money;
import org.broadleafcommerce.common.presentation.AdminPresentation;
import org.broadleafcommerce.common.presentation.AdminPresentationClass;
import org.broadleafcommerce.common.presentation.AdminPresentationMap;
import org.broadleafcommerce.common.presentation.AdminPresentationMapKey;
import org.broadleafcommerce.common.presentation.client.SupportedFieldType;
import org.broadleafcommerce.common.presentation.client.VisibilityEnum;
import org.broadleafcommerce.common.util.DateUtil;
import org.broadleafcommerce.core.catalog.service.dynamic.DefaultDynamicSkuPricingInvocationHandler;
import org.broadleafcommerce.core.catalog.service.dynamic.DynamicSkuPrices;
import org.broadleafcommerce.core.catalog.service.dynamic.SkuPricingConsiderationContext;
import org.broadleafcommerce.core.inventory.service.type.InventoryType;
import org.broadleafcommerce.core.media.domain.Media;
import org.broadleafcommerce.core.media.domain.MediaImpl;
import org.broadleafcommerce.core.order.domain.FulfillmentOption;
import org.broadleafcommerce.core.order.domain.FulfillmentOptionImpl;
import org.broadleafcommerce.core.order.service.type.FulfillmentType;
import org.hibernate.annotations.BatchSize;
import org.hibernate.annotations.Cache;
import org.hibernate.annotations.CacheConcurrencyStrategy;
import org.hibernate.annotations.Cascade;
import org.hibernate.annotations.GenericGenerator;
import org.hibernate.annotations.Index;
import org.hibernate.annotations.MapKey;
import org.hibernate.annotations.Parameter;
import org.hibernate.annotations.Type;
import java.lang.reflect.Proxy;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.persistence.CascadeType;
import javax.persistence.CollectionTable;
import javax.persistence.Column;
import javax.persistence.ElementCollection;
import javax.persistence.Embedded;
import javax.persistence.Entity;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;
import javax.persistence.Inheritance;
import javax.persistence.InheritanceType;
import javax.persistence.JoinColumn;
import javax.persistence.JoinTable;
import javax.persistence.Lob;
import javax.persistence.ManyToMany;
import javax.persistence.ManyToOne;
import javax.persistence.MapKeyClass;
import javax.persistence.MapKeyJoinColumn;
import javax.persistence.OneToMany;
import javax.persistence.OneToOne;
import javax.persistence.Table;
import javax.persistence.Transient;
/**
* The Class SkuImpl is the default implementation of {@link Sku}. A SKU is a
* specific item that can be sold including any specific attributes of the item
* such as color or size. skuMedia = new HashMap();
/**
* This will be non-null if and only if this Sku is the default Sku for a Product
*/
@OneToOne(optional = true, targetEntity = ProductImpl.class, cascade = {CascadeType.ALL})
@Cascade(value = {org.hibernate.annotations.CascadeType.ALL})
@JoinColumn(name = "DEFAULT_PRODUCT_ID")
protected Product defaultProduct;
/**
* This relationship will be non-null if and only if this Sku is contained in the list of
* additional Skus for a Product (for Skus based on ProductOptions)
*/
@ManyToOne(optional = true, targetEntity = ProductImpl.class)
@JoinTable(name = "BLC_PRODUCT_SKU_XREF", joinColumns = @JoinColumn(name = "SKU_ID", referencedColumnName = "SKU_ID"), inverseJoinColumns = @JoinColumn(name = "PRODUCT_ID", referencedColumnName = "PRODUCT_ID"))
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE, region = "blStandardElements")
protected Product product;
@OneToMany(mappedBy = "sku", targetEntity = SkuAttributeImpl.class, cascade = {CascadeType.ALL})
@Cascade(value = {org.hibernate.annotations.CascadeType.ALL, org.hibernate.annotations.CascadeType.DELETE_ORPHAN})
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE, region = "blStandardElements")
@BatchSize(size = 50)
protected List skuAttributes = new ArrayList();
@ManyToMany(targetEntity = ProductOptionValueImpl.class)
@JoinTable(name = "BLC_SKU_OPTION_VALUE_XREF", joinColumns = @JoinColumn(name = "SKU_ID", referencedColumnName = "SKU_ID"), inverseJoinColumns = @JoinColumn(name = "PRODUCT_OPTION_VALUE_ID", referencedColumnName = "PRODUCT_OPTION_VALUE_ID"))
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE, region = "blStandardElements")
@BatchSize(size = 50)
protected List productOptionValues = new ArrayList();
@ManyToMany(fetch = FetchType.LAZY, targetEntity = SkuFeeImpl.class)
@JoinTable(name = "BLC_SKU_FEE_XREF",
joinColumns = @JoinColumn(name = "SKU_ID", referencedColumnName = "SKU_ID", nullable = true),
inverseJoinColumns = @JoinColumn(name = "SKU_FEE_ID", referencedColumnName = "SKU_FEE_ID", nullable = true))
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE, region = "blStandardElements")
protected List fees = new ArrayList();
@ElementCollection
@CollectionTable(name = "BLC_SKU_FULFILLMENT_FLAT_RATES", joinColumns = @JoinColumn(name = "SKU_ID", referencedColumnName = "SKU_ID", nullable = true))
@MapKeyJoinColumn(name = "FULFILLMENT_OPTION_ID", referencedColumnName = "FULFILLMENT_OPTION_ID")
@MapKeyClass(FulfillmentOptionImpl.class)
@Column(name = "RATE", precision = 19, scale = 5)
@Cascade(org.hibernate.annotations.CascadeType.ALL)
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE, region = "blStandardElements")
protected Map fulfillmentFlatRates = new HashMap();
@ManyToMany(targetEntity = FulfillmentOptionImpl.class)
@JoinTable(name = "BLC_SKU_FULFILLMENT_EXCLUDED",
joinColumns = @JoinColumn(name = "SKU_ID", referencedColumnName = "SKU_ID"),
inverseJoinColumns = @JoinColumn(name = "FULFILLMENT_OPTION_ID", referencedColumnName = "FULFILLMENT_OPTION_ID"))
@Cache(usage = CacheConcurrencyStrategy.READ_WRITE, region = "blStandardElements")
@BatchSize(size = 50)
protected List excludedFulfillmentOptions = new ArrayList();
@Column(name = "INVENTORY_TYPE")
@AdminPresentation(friendlyName = "SkuImpl_Sku_InventoryType", group = "SkuImpl_Sku_Inventory", order = 10, fieldType = SupportedFieldType.BROADLEAF_ENUMERATION, broadleafEnumeration = "org.broadleafcommerce.core.inventory.service.type.InventoryType")
protected String inventoryType;
@Column(name = "FULFILLMENT_TYPE")
@AdminPresentation(friendlyName = "SkuImpl_Sku_FulfillmentType", group = "SkuImpl_Sku_Inventory", order = 11, fieldType = SupportedFieldType.BROADLEAF_ENUMERATION, broadleafEnumeration = "org.broadleafcommerce.core.order.service.type.FulfillmentType")
protected String fulfillmentType;
@Override
public Long getId() {
return id;
}
@Override
public void setId(Long id) {
this.id = id;
}
@Override
public boolean isOnSale() {
Money retailPrice = getRetailPrice();
Money salePrice = getSalePrice();
return (salePrice != null && !salePrice.isZero() && salePrice.lessThan(retailPrice));
}
protected boolean hasDefaultSku() {
return (product != null && product.getDefaultSku() != null && !getId().equals(product.getDefaultSku().getId()));
}
protected Sku lookupDefaultSku() {
if (product != null && product.getDefaultSku() != null) {
return product.getDefaultSku();
} else {
return null;
}
}
@Override
public Money getProductOptionValueAdjustments() {
Money optionValuePriceAdjustments = null;
if (getProductOptionValues() != null) {
for (ProductOptionValue value : getProductOptionValues()) {
if (value.getPriceAdjustment() != null) {
if (optionValuePriceAdjustments == null) {
optionValuePriceAdjustments = value.getPriceAdjustment();
} else {
optionValuePriceAdjustments = optionValuePriceAdjustments.add(value.getPriceAdjustment());
}
}
}
}
return optionValuePriceAdjustments;
}
@Override
public Money getSalePrice() {
Money returnPrice = null;
// TODO: See if there is a dynamic price for this SKU
if (SkuPricingConsiderationContext.hasDynamicPricing()) {
if (dynamicPrices != null) {
returnPrice = dynamicPrices.getSalePrice();
} else {
DefaultDynamicSkuPricingInvocationHandler handler = new DefaultDynamicSkuPricingInvocationHandler(this);
Sku proxy = (Sku) Proxy.newProxyInstance(getClass().getClassLoader(), getClass().getInterfaces(), handler);
dynamicPrices = SkuPricingConsiderationContext.getSkuPricingService().getSkuPrices(proxy, SkuPricingConsiderationContext.getSkuPricingConsiderationContext());
returnPrice = dynamicPrices.getSalePrice();
}
} else {
if (salePrice != null) {
returnPrice = new Money(salePrice, Money.defaultCurrency());
}
}
// Get the price from the default SKU
if (returnPrice == null && hasDefaultSku()) {
returnPrice = lookupDefaultSku().getSalePrice();
}
Money optionValueAdjustments = null;
if (dynamicPrices != null) {
optionValueAdjustments = dynamicPrices.getPriceAdjustment();
} else {
optionValueAdjustments = getProductOptionValueAdjustments();
}
if (optionValueAdjustments == null) {
//return returnPrice;
} else {
returnPrice = returnPrice == null ? optionValueAdjustments : optionValueAdjustments.add(returnPrice);
}
return returnPrice;
}
@Override
public void setSalePrice(Money salePrice) {
this.salePrice = Money.toAmount(salePrice);
}
@Override
public Money getRetailPrice() {
Money returnPrice = null;
if (SkuPricingConsiderationContext.hasDynamicPricing()) {
if (dynamicPrices != null) {
returnPrice = dynamicPrices.getRetailPrice();
} else {
DefaultDynamicSkuPricingInvocationHandler handler = new DefaultDynamicSkuPricingInvocationHandler(this);
Sku proxy = (Sku) Proxy.newProxyInstance(getClass().getClassLoader(), getClass().getInterfaces(), handler);
dynamicPrices = SkuPricingConsiderationContext.getSkuPricingService().getSkuPrices(proxy, SkuPricingConsiderationContext.getSkuPricingConsiderationContext());
returnPrice = dynamicPrices.getRetailPrice();
}
} else {
if (retailPrice != null) {
returnPrice = new Money(retailPrice, Money.defaultCurrency());
}
}
// Get the price from the default SKU
if (returnPrice == null && hasDefaultSku()) {
returnPrice = lookupDefaultSku().getRetailPrice();
}
Money optionValueAdjustments = null;
if (dynamicPrices != null) {
optionValueAdjustments = dynamicPrices.getPriceAdjustment();
} else {
optionValueAdjustments = getProductOptionValueAdjustments();
}
if (optionValueAdjustments == null) {
//return returnPrice;
} else {
returnPrice = returnPrice == null ? optionValueAdjustments : optionValueAdjustments.add(returnPrice);
}
return returnPrice;
}
@Override
public void setRetailPrice(Money retailPrice) {
this.retailPrice = Money.toAmount(retailPrice);
}
@Override
public Money getListPrice() {
return getRetailPrice();
}
@Override
public void setListPrice(Money listPrice) {
this.retailPrice = Money.toAmount(listPrice);
}
@Override
public String getName() {
if (name == null && hasDefaultSku()) {
return lookupDefaultSku().getName();
}
return name;
}
@Override
public void setName(String name) {
this.name = name;
}
@Override
public String getDescription() {
if (description == null && hasDefaultSku()) {
return lookupDefaultSku().getDescription();
}
return description;
}
@Override
public void setDescription(String description) {
this.description = description;
}
@Override
public String getLongDescription() {
if (longDescription == null && hasDefaultSku()) {
return lookupDefaultSku().getLongDescription();
}
return longDescription;
}
@Override
public void setLongDescription(String longDescription) {
this.longDescription = longDescription;
}
@Override
public Boolean isTaxable() {
if (taxable == null) {
if (hasDefaultSku()) {
return lookupDefaultSku().isTaxable();
}
return null;
}
return taxable == 'Y' ? Boolean.TRUE : Boolean.FALSE;
}
@Override
public Boolean getTaxable() {
return isTaxable();
}
@Override
public void setTaxable(Boolean taxable) {
if (taxable == null) {
this.taxable = null;
} else {
this.taxable = taxable ? 'Y' : 'N';
}
}
@Override
public Boolean isDiscountable() {
if (discountable == null) {
if (hasDefaultSku()) {
return lookupDefaultSku().isDiscountable();
}
return Boolean.FALSE;
}
return discountable == 'Y' ? Boolean.TRUE : Boolean.FALSE;
}
/*
* This is to facilitate serialization to non-Java clients
*/
public Boolean getDiscountable() {
return isDiscountable();
}
@Override
public void setDiscountable(Boolean discountable) {
if (discountable == null) {
this.discountable = null;
} else {
this.discountable = discountable ? 'Y' : 'N';
}
}
@Override
public Boolean isAvailable() {
if (available == null) {
if (hasDefaultSku()) {
return lookupDefaultSku().isAvailable();
}
return null;
}
return available == 'Y' ? Boolean.TRUE : Boolean.FALSE;
}
@Override
public Boolean getAvailable() {
return isAvailable();
}
@Override
public void setAvailable(Boolean available) {
if (available == null) {
this.available = null;
} else {
this.available = available ? 'Y' : 'N';
}
}
@Override
public Date getActiveStartDate() {
if (activeStartDate == null && hasDefaultSku()) {
return lookupDefaultSku().getActiveStartDate();
} else {
return activeStartDate;
}
}
@Override
public void setActiveStartDate(Date activeStartDate) {
this.activeStartDate = activeStartDate;
}
@Override
public Date getActiveEndDate() {
if (activeEndDate == null && hasDefaultSku()) {
return lookupDefaultSku().getActiveEndDate();
} else {
return activeEndDate;
}
}
@Override
public void setActiveEndDate(Date activeEndDate) {
this.activeEndDate = activeEndDate;
}
@Override
public Dimension getDimension() {
if (dimension == null && hasDefaultSku()) {
return lookupDefaultSku().getDimension();
} else {
return dimension;
}
}
@Override
public void setDimension(Dimension dimension) {
this.dimension = dimension;
}
@Override
public Weight getWeight() {
if (weight == null && hasDefaultSku()) {
return lookupDefaultSku().getWeight();
} else {
return weight;
}
}
@Override
public void setWeight(Weight weight) {
this.weight = weight;
}
@Override
public boolean isActive() {
if (activeStartDate == null && activeEndDate == null && hasDefaultSku()) {
return lookupDefaultSku().isActive();
}
if (LOG.isDebugEnabled()) {
if (!DateUtil.isActive(getActiveStartDate(), getActiveEndDate(), true)) {
LOG.debug("sku, " + id + ", inactive due to date");
}
}
return DateUtil.isActive(getActiveStartDate(), getActiveEndDate(), true);
}
@Override
public boolean isActive(Product product, Category category) {
if (LOG.isDebugEnabled()) {
if (!DateUtil.isActive(getActiveStartDate(), getActiveEndDate(), true)) {
LOG.debug("sku, " + id + ", inactive due to date");
} else if (!product.isActive()) {
LOG.debug("sku, " + id + ", inactive due to product being inactive");
} else if (!category.isActive()) {
LOG.debug("sku, " + id + ", inactive due to category being inactive");
}
}
return this.isActive() && (product == null || product.isActive()) && (category == null || category.isActive());
}
@Override
public Map getSkuMedia() {
if (skuMedia == null || skuMedia.isEmpty()) {
if (hasDefaultSku()) {
return lookupDefaultSku().getSkuMedia();
}
}
return skuMedia;
}
@Override
public void setSkuMedia(Map skuMedia) {
this.skuMedia = skuMedia;
}
@Override
public Product getDefaultProduct() {
return defaultProduct;
}
@Override
public void setDefaultProduct(Product defaultProduct) {
this.defaultProduct = defaultProduct;
}
@Override
public Product getProduct() {
return (getDefaultProduct() != null) ? getDefaultProduct() : this.product;
}
@Override
public void setProduct(Product product) {
this.product = product;
}
@Override
public List getSkuAttributes() {
return skuAttributes;
}
@Override
public SkuAttribute getSkuAttributeByName(String name) {
for (SkuAttribute attribute : getSkuAttributes()) {
if (attribute.getName().equals(name)) {
return attribute;
}
}
return null;
}
@Override
public Map getMappedSkuAttributes() {
Map map = new HashMap();
for (SkuAttribute attr : getSkuAttributes()) {
map.put(attr.getName(), attr);
}
return map;
}
@Override
public List getProductOptionValues() {
return productOptionValues;
}
@Override
public void setProductOptionValues(List productOptionValues) {
this.productOptionValues = productOptionValues;
}
@Override
public void setSkuAttributes(List skuAttributes) {
this.skuAttributes = skuAttributes;
}
@Override
@Deprecated
public Boolean isMachineSortable() {
if (isMachineSortable == null && hasDefaultSku()) {
return lookupDefaultSku().isMachineSortable();
}
return isMachineSortable == null ? false : isMachineSortable;
}
public Boolean getIsMachineSortable() {
if (isMachineSortable == null && hasDefaultSku()) {
return lookupDefaultSku().getIsMachineSortable();
}
return isMachineSortable == null ? false : isMachineSortable;
}
@Override
@Deprecated
public void setMachineSortable(Boolean isMachineSortable) {
this.isMachineSortable = isMachineSortable;
}
public void setIsMachineSortable(Boolean isMachineSortable) {
this.isMachineSortable = isMachineSortable;
}
@Override
public List getFees() {
return fees;
}
@Override
public void setFees(List fees) {
this.fees = fees;
}
@Override
public Map getFulfillmentFlatRates() {
return fulfillmentFlatRates;
}
@Override
public void setFulfillmentFlatRates(Map fulfillmentFlatRates) {
this.fulfillmentFlatRates = fulfillmentFlatRates;
}
@Override
public List getExcludedFulfillmentOptions() {
return excludedFulfillmentOptions;
}
@Override
public void setExcludedFulfillmentOptions(List excludedFulfillmentOptions) {
this.excludedFulfillmentOptions = excludedFulfillmentOptions;
}
@Override
public InventoryType getInventoryType() {
return InventoryType.getInstance(this.inventoryType);
}
@Override
public void setInventoryType(InventoryType inventoryType) {
this.inventoryType = inventoryType.getType();
}
@Override
public FulfillmentType getFulfillmentType() {
return FulfillmentType.getInstance(this.fulfillmentType);
}
@Override
public void setFulfillmentType(FulfillmentType fulfillmentType) {
this.fulfillmentType = fulfillmentType.getType();
}
@Override
public void clearDynamicPrices() {
this.dynamicPrices = null;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
SkuImpl other = (SkuImpl) obj;
if (id != null && other.id != null) {
return id.equals(other.id);
}
if (getName() == null) {
if (other.getName() != null) {
return false;
}
} else if (!getName().equals(other.getName())) {
return false;
}
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + ((getName() == null) ? 0 : getName().hashCode());
return result;
}
}
