com.neurosys.products.domain

Class Product

java.lang.Object

com.neurosys.domain.ModelObject

com.neurosys.domain.DomainObject

com.neurosys.domain.HierarchialDomainObject

com.neurosys.domain.HierarchialDomainObjectWithAttributes<Product,ProductAttribute>

com.neurosys.products.domain.Product

All Implemented Interfaces:

Attributes<Product,String>, Displayable, IHierarchialReference<Long>, Identifiable<Long>, IProductReference, Serializable, Cloneable, org.apache.commons.collections.Transformer

Direct Known Subclasses:

Product

@Entity
public class Product
extends HierarchialDomainObjectWithAttributes<Product,ProductAttribute>
implements IProductReference, Identifiable<Long>, org.apache.commons.collections.Transformer

Master Object for Product
An entity with a default Inheritance.strategy() as InheritanceType.SINGLE_TABLE and a default DiscriminatorValue default

Author:

Arjun Dhar

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Product.BIT_MASKS

Field Summary

Fields inherited from class com.neurosys.domain.HierarchialDomainObject

ATTRIB_HIERARCHY_STARTS_LIKE, ATTRIB_PRODUCT_PARENT, displayName, parentId

Fields inherited from interface com.neurosys.domain.IHierarchialReference

ROOT

Constructor Summary

Constructors

Constructor and Description
Product()
Product(Product p)
Product(ProductReference ref)
Product(String json)

Method Summary

Modifier and Type	Method and Description
Product	clone()
Map<String,ProductAttribute>	getAttributes() Any attribute that is not common for most of the entities belongs to be an Attribute rather than a field.
Integer	getBitmask()
String	getDescription()
Long	getId() Id with GeneratedValue.strategy() of GenerationType.AUTO
String	getModelCode() A code that identifies a product's model.
String	getName() Unique Name to refer to the record Id is an Auto generated number used by the system, but is difficult for the outside world to get a handle on it.
String	getProductCode() A code uniquely identifies a product and has a one to one mapping with SKU. However this is optional and a more human readable way to recognize the product in the system.
ProductReference	getReference()
String	getRelatedGroups() A JSON string of the format ["sku":[.,.,.],"modelCode":[...],"productCode":[.,.,.]] This defines a collection/group related to this product.
String	getTags() Comma separated list of tag Ids
String	safeDisplayName() Display Name (Can contain HTML) If you want to display the name without HTML use MarshalUtils.regexReplace(safeDisplayName, HTMLUtils.html4Replacer)
Product	setAttribute(String name, String value) Any attribute that is not common for most of the entities belongs to be an Attribute rather than a field.
void	setAttributes(Map<String,ProductAttribute> attributes) Any attribute that is not common for most of the entities belongs to be an Attribute rather than a field.
void	setBitmask(Integer bitmask)
void	setDescription(String description)
void	setId(Long id) Id with GeneratedValue.strategy() of GenerationType.AUTO
void	setModelCode(String modelCode) A code that identifies a product's model.
void	setName(String name) Unique Name to refer to the record Id is an Auto generated number used by the system, but is difficult for the outside world to get a handle on it.
void	setProductCode(String productCode) A code uniquely identifies a product and has a one to one mapping with SKU. However this is optional and a more human readable way to recognize the product in the system.
void	setRelatedGroups(String relatedGroups) A JSON string of the format ["sku":[.,.,.],"modelCode":[...],"productCode":[.,.,.]] This defines a collection/group related to this product.
void	setTags(String tags) Comma separated list of tag Ids
String	transform(Object obj)

Methods inherited from class com.neurosys.domain.HierarchialDomainObjectWithAttributes

getAttribute, getAttributeValue

Methods inherited from class com.neurosys.domain.HierarchialDomainObject

equals, getDisplayName, getHierarchy, getParentId, hashCode, setDisplayName, setHierarchy, setParentId, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.neurosys.domain.IHierarchialReference

getHierarchy, getParentId, setHierarchy, setParentId

Methods inherited from interface com.neurosys.domain.Displayable

getDisplayName

Constructor Detail

Product

public Product()

Product

public Product(String json)

Product

public Product(Product p)

Product

public Product(ProductReference ref)

Method Detail

getId

public Long getId()

Id with GeneratedValue.strategy() of GenerationType.AUTO

Specified by:

getId in interface IHierarchialReference<Long>

Specified by:

getId in interface Identifiable<Long>

setId

public void setId(Long id)

Id with GeneratedValue.strategy() of GenerationType.AUTO

Specified by:

setId in interface IHierarchialReference<Long>

Specified by:

setId in interface Identifiable<Long>

safeDisplayName

public String safeDisplayName()

Display Name (Can contain HTML)
If you want to display the name without HTML use MarshalUtils.regexReplace(safeDisplayName, HTMLUtils.html4Replacer)

Can be null:

false if name is null then getName() will return name

getName

public String getName()

Unique Name to refer to the record Id is an Auto generated number used by the system, but is difficult for the outside world to get a handle on it.

Specified by:

getName in interface IHierarchialReference<Long>

Can be null:

true (if true it means its a place holder and does not point to any real product or category. Example: Root)

setName

public void setName(String name)

Unique Name to refer to the record Id is an Auto generated number used by the system, but is difficult for the outside world to get a handle on it.

Specified by:

setName in interface IHierarchialReference<Long>

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getTags

public String getTags()

Comma separated list of tag Ids

Returns:

String

setTags

public void setTags(String tags)

Comma separated list of tag Ids

Parameters:

String -

getBitmask

public Integer getBitmask()

See Also:

Product.BIT_MASKS

setBitmask

public void setBitmask(Integer bitmask)

See Also:

Product.BIT_MASKS

getAttributes

public Map<String,ProductAttribute> getAttributes()

Any attribute that is not common for most of the entities belongs to be an Attribute rather than a field.
Attributes usually represent fluid variations within Products and product Types that are loosely defined for some products.

Specified by:

getAttributes in class HierarchialDomainObjectWithAttributes<Product,ProductAttribute>

setAttributes

public void setAttributes(Map<String,ProductAttribute> attributes)

Any attribute that is not common for most of the entities belongs to be an Attribute rather than a field.
Attributes usually represent fluid variations within Products and product Types that are loosely defined for some products.

Specified by:

setAttributes in class HierarchialDomainObjectWithAttributes<Product,ProductAttribute>

setAttribute

public Product setAttribute(String name,
                            String value)

Any attribute that is not common for most of the entities belongs to be an Attribute rather than a field.
Attributes usually represent fluid variations within Products and product Types that are loosely defined for some products.

Specified by:

setAttribute in interface Attributes<Product,String>

Specified by:

setAttribute in class HierarchialDomainObjectWithAttributes<Product,ProductAttribute>

Parameters:

name - as String

value - as value type

Returns:

this object

getProductCode

public String getProductCode()

A code uniquely identifies a product and has a one to one mapping with SKU.
However this is optional and a more human readable way to recognize the product in the system.
In face this product represents a collection then also this maybe null since business may not have defined this for a group of products.

Specified by:

getProductCode in interface IProductReference

Can be null:

true

setProductCode

public void setProductCode(String productCode)

A code uniquely identifies a product and has a one to one mapping with SKU.
However this is optional and a more human readable way to recognize the product in the system.
In face this product represents a collection then also this maybe null since business may not have defined this for a group of products.

Specified by:

setProductCode in interface IProductReference

Can be null:

true

getModelCode

public String getModelCode()

A code that identifies a product's model. There is a One to mapping between this and productCode & #sku.

Can be null:

true

setModelCode

public void setModelCode(String modelCode)

A code that identifies a product's model. There is a One to mapping between this and productCode & #sku.

Can be null:

true

getRelatedGroups

public String getRelatedGroups()

A JSON string of the format ["sku":[.,.,.],"modelCode":[...],"productCode":[.,.,.]]
This defines a collection/group related to this product. Sometimes, collections of objects need to be sold together as one unit but can consist of multiple units. Example: Tea Set.
This JSON string will contain the detail of that association

setRelatedGroups

public void setRelatedGroups(String relatedGroups)

A JSON string of the format ["sku":[.,.,.],"modelCode":[...],"productCode":[.,.,.]]
This defines a collection/group related to this product. Sometimes, collections of objects need to be sold together as one unit but can consist of multiple units. Example: Tea Set.
This JSON string will contain the detail of that association

getReference

public ProductReference getReference()

clone

public Product clone()
              throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

transform

public String transform(Object obj)

Specified by:

transform in interface org.apache.commons.collections.Transformer