com.eteks.sweethome3d.model

Class CatalogPieceOfFurniture

java.lang.Object

com.eteks.sweethome3d.model.CatalogPieceOfFurniture

All Implemented Interfaces:

CatalogItem, PieceOfFurniture, java.lang.Cloneable, java.lang.Comparable<CatalogPieceOfFurniture>

Direct Known Subclasses:

CatalogDoorOrWindow, CatalogLight, CatalogShelfUnit

public class CatalogPieceOfFurniture
extends java.lang.Object
implements java.lang.Comparable<CatalogPieceOfFurniture>, PieceOfFurniture, CatalogItem, java.lang.Cloneable

A catalog piece of furniture.

Author:

Emmanuel Puybaret

Field Summary

Fields inherited from interface com.eteks.sweethome3d.model.PieceOfFurniture

DEFAULT_CUT_OUT_SHAPE, HIDE_EDGE_COLOR_MATERIAL, IDENTITY_ROTATION, SHOW_BACK_FACE

Constructor Summary

Constructors

Constructor and Description
CatalogPieceOfFurniture(java.lang.String name, Content icon, Content model, float width, float depth, float height, boolean movable, boolean doorOrWindow) Deprecated. As of version 1.7, use constructor without doorOrWindow parameter since a catalog door and window is supposed to be an instance of CatalogDoorOrWindow
CatalogPieceOfFurniture(java.lang.String name, Content icon, Content model, float width, float depth, float height, float elevation, boolean movable, boolean doorOrWindow, java.lang.Integer color, float[][] modelRotation, boolean backFaceShown, float iconYaw, boolean proportional) Deprecated. As of version 1.7, use constructor without doorOrWindow parameter since a catalog door and window is supposed to be an instance of CatalogDoorOrWindow
CatalogPieceOfFurniture(java.lang.String name, Content icon, Content model, float width, float depth, float height, float elevation, boolean movable, java.lang.Integer color, float[][] modelRotation, boolean backFaceShown, float iconYaw, boolean proportional) Creates a modifiable catalog piece of furniture with all its values.
CatalogPieceOfFurniture(java.lang.String name, Content icon, Content model, float width, float depth, float height, float elevation, boolean movable, java.lang.String staircaseCutOutShape, java.lang.Integer color, float[][] modelRotation, boolean backFaceShown, float iconYaw, boolean proportional) Creates a modifiable catalog piece of furniture with all its values.
CatalogPieceOfFurniture(java.lang.String name, Content icon, Content model, float width, float depth, float height, float elevation, boolean movable, java.lang.String staircaseCutOutShape, java.lang.Integer color, float[][] modelRotation, boolean backFaceShown, java.lang.Long modelSize, java.lang.String creator, float iconYaw, boolean proportional) Creates a modifiable catalog piece of furniture with all its values.
CatalogPieceOfFurniture(java.lang.String name, Content icon, Content model, float width, float depth, float height, float elevation, boolean movable, java.lang.String staircaseCutOutShape, java.lang.Integer color, float[][] modelRotation, int modelFlags, java.lang.Long modelSize, java.lang.String creator, float iconYaw, float iconPitch, float iconScale, boolean proportional) Creates a modifiable catalog piece of furniture with all its values.
CatalogPieceOfFurniture(java.lang.String id, java.lang.String name, java.lang.String description, Content icon, Content planIcon, Content model, float width, float depth, float height, float elevation, boolean movable, float[][] modelRotation, java.lang.String creator, boolean resizable, java.math.BigDecimal price, java.math.BigDecimal valueAddedTaxPercentage) Creates an unmodifiable catalog piece of furniture of the default catalog.
CatalogPieceOfFurniture(java.lang.String id, java.lang.String name, java.lang.String description, Content icon, Content planIcon, Content model, float width, float depth, float height, float elevation, boolean movable, float[][] modelRotation, java.lang.String creator, boolean resizable, boolean deformable, boolean texturable, java.math.BigDecimal price, java.math.BigDecimal valueAddedTaxPercentage) Creates an unmodifiable catalog piece of furniture of the default catalog.
CatalogPieceOfFurniture(java.lang.String id, java.lang.String name, java.lang.String description, Content icon, Content planIcon, Content model, float width, float depth, float height, float elevation, boolean movable, java.lang.String staircaseCutOutShape, float[][] modelRotation, java.lang.String creator, boolean resizable, boolean deformable, boolean texturable, java.math.BigDecimal price, java.math.BigDecimal valueAddedTaxPercentage, java.lang.String currency) Creates an unmodifiable catalog piece of furniture of the default catalog.
CatalogPieceOfFurniture(java.lang.String id, java.lang.String name, java.lang.String description, Content icon, Content model, float width, float depth, float height, float elevation, boolean movable, boolean doorOrWindow, float[][] modelRotation, java.lang.String creator, boolean resizable, java.math.BigDecimal price, java.math.BigDecimal valueAddedTaxPercentage) Deprecated. As of version 1.7, use constructor without doorOrWindow parameter since a catalog door and window is supposed to be an instance of CatalogDoorOrWindow
CatalogPieceOfFurniture(java.lang.String id, java.lang.String name, java.lang.String description, Content icon, Content model, float width, float depth, float height, float elevation, boolean movable, float[][] modelRotation, java.lang.String creator, boolean resizable, java.math.BigDecimal price, java.math.BigDecimal valueAddedTaxPercentage) Creates an unmodifiable catalog piece of furniture of the default catalog.
CatalogPieceOfFurniture(java.lang.String id, java.lang.String name, java.lang.String description, java.lang.String information, java.lang.String[] tags, java.lang.Long creationDate, java.lang.Float grade, Content icon, Content planIcon, Content model, float width, float depth, float height, float elevation, boolean movable, java.lang.String staircaseCutOutShape, float[][] modelRotation, java.lang.String creator, boolean resizable, boolean deformable, boolean texturable, java.math.BigDecimal price, java.math.BigDecimal valueAddedTaxPercentage, java.lang.String currency) Creates an unmodifiable catalog piece of furniture of the default catalog.
CatalogPieceOfFurniture(java.lang.String id, java.lang.String name, java.lang.String description, java.lang.String information, java.lang.String[] tags, java.lang.Long creationDate, java.lang.Float grade, Content icon, Content planIcon, Content model, float width, float depth, float height, float elevation, float dropOnTopElevation, boolean movable, java.lang.String staircaseCutOutShape, float[][] modelRotation, boolean backFaceShown, java.lang.Long modelSize, java.lang.String creator, boolean resizable, boolean deformable, boolean texturable, boolean horizontallyRotatable, java.math.BigDecimal price, java.math.BigDecimal valueAddedTaxPercentage, java.lang.String currency) Creates an unmodifiable catalog piece of furniture of the default catalog.
CatalogPieceOfFurniture(java.lang.String id, java.lang.String name, java.lang.String description, java.lang.String information, java.lang.String[] tags, java.lang.Long creationDate, java.lang.Float grade, Content icon, Content planIcon, Content model, float width, float depth, float height, float elevation, float dropOnTopElevation, boolean movable, java.lang.String staircaseCutOutShape, float[][] modelRotation, boolean backFaceShown, java.lang.Long modelSize, java.lang.String creator, boolean resizable, boolean deformable, boolean texturable, boolean horizontallyRotatable, java.math.BigDecimal price, java.math.BigDecimal valueAddedTaxPercentage, java.lang.String currency, java.util.Map<java.lang.String,java.lang.String> properties) Creates an unmodifiable catalog piece of furniture of the default catalog.
CatalogPieceOfFurniture(java.lang.String id, java.lang.String name, java.lang.String description, java.lang.String information, java.lang.String[] tags, java.lang.Long creationDate, java.lang.Float grade, Content icon, Content planIcon, Content model, float width, float depth, float height, float elevation, float dropOnTopElevation, boolean movable, java.lang.String staircaseCutOutShape, float[][] modelRotation, boolean backFaceShown, java.lang.String creator, boolean resizable, boolean deformable, boolean texturable, java.math.BigDecimal price, java.math.BigDecimal valueAddedTaxPercentage, java.lang.String currency) Creates an unmodifiable catalog piece of furniture of the default catalog.
CatalogPieceOfFurniture(java.lang.String id, java.lang.String name, java.lang.String description, java.lang.String information, java.lang.String[] tags, java.lang.Long creationDate, java.lang.Float grade, Content icon, Content planIcon, Content model, float width, float depth, float height, float elevation, float dropOnTopElevation, boolean movable, java.lang.String staircaseCutOutShape, float[][] modelRotation, int modelFlags, java.lang.Long modelSize, java.lang.String creator, boolean resizable, boolean deformable, boolean texturable, boolean horizontallyRotatable, java.math.BigDecimal price, java.math.BigDecimal valueAddedTaxPercentage, java.lang.String currency, java.util.Map<java.lang.String,java.lang.String> properties) Creates an unmodifiable catalog piece of furniture of the default catalog.
CatalogPieceOfFurniture(java.lang.String id, java.lang.String name, java.lang.String description, java.lang.String information, java.lang.String[] tags, java.lang.Long creationDate, java.lang.Float grade, Content icon, Content planIcon, Content model, float width, float depth, float height, float elevation, float dropOnTopElevation, boolean movable, java.lang.String staircaseCutOutShape, float[][] modelRotation, java.lang.String creator, boolean resizable, boolean deformable, boolean texturable, java.math.BigDecimal price, java.math.BigDecimal valueAddedTaxPercentage, java.lang.String currency) Creates an unmodifiable catalog piece of furniture of the default catalog.
CatalogPieceOfFurniture(java.lang.String id, java.lang.String name, java.lang.String description, java.lang.String information, java.lang.String license, java.lang.String[] tags, java.lang.Long creationDate, java.lang.Float grade, Content icon, Content planIcon, Content model, float width, float depth, float height, float elevation, float dropOnTopElevation, boolean movable, java.lang.String staircaseCutOutShape, float[][] modelRotation, int modelFlags, java.lang.Long modelSize, java.lang.String creator, boolean resizable, boolean deformable, boolean texturable, boolean horizontallyRotatable, java.math.BigDecimal price, java.math.BigDecimal valueAddedTaxPercentage, java.lang.String currency, java.util.Map<java.lang.String,java.lang.String> properties, java.util.Map<java.lang.String,Content> contents) Creates an unmodifiable catalog piece of furniture of the default catalog.

Method Summary

Modifier and Type	Method and Description
CatalogPieceOfFurniture	clone() Returns a clone of this piece.
int	compareTo(CatalogPieceOfFurniture piece) Compares the names of this piece and the one in parameter.
boolean	equals(java.lang.Object obj) Returns true if this piece and the one in parameter are the same objects.
FurnitureCategory	getCategory() Returns the category of this piece of furniture.
java.lang.Integer	getColor() Returns the color of this piece of furniture.
Content	getContentProperty(java.lang.String name) Returns the value of an additional content name associated to this piece.
java.lang.Long	getCreationDate() Returns the creation date of this piece in milliseconds since the epoch, or null if no date is given to this piece.
java.lang.String	getCreator() Returns the creator of this piece.
java.lang.String	getCurrency() Returns the price currency, noted with ISO 4217 code, or null if it has no price or default currency should be used.
float	getDepth() Returns the depth of this piece of furniture.
java.lang.String	getDescription() Returns the description of this piece of furniture.
float	getDropOnTopElevation() Returns the elevation at which should be placed an object dropped on this piece.
float	getElevation() Returns the elevation of this piece of furniture.
protected java.lang.String[]	getFilterCriteria() Returns the strings used as criteria for filtering (name, category, creator, license, description and tags).
java.lang.Float	getGrade() Returns the grade of this piece, or null if no grade is given to this piece.
float	getHeight() Returns the height of this piece of furniture.
Content	getIcon() Returns the icon of this piece of furniture.
float	getIconPitch() Returns the pitch angle used to create the piece icon.
float	getIconScale() Returns the scale used to create the piece icon.
float	getIconYaw() Returns the yaw angle used to create the piece icon.
java.lang.String	getId() Returns the ID of this piece of furniture or null.
java.lang.String	getInformation() Returns the additional information associated to this piece, or null.
java.lang.String	getLicense() Returns the license associated to this piece, or null.
Content	getModel() Returns the 3D model of this piece of furniture.
int	getModelFlags() Returns the flags which should be applied to the 3D model of this piece of furniture.
float[][]	getModelRotation() Returns the rotation 3 by 3 matrix of this piece of furniture that ensures its model is correctly oriented.
java.lang.Long	getModelSize() Returns the size of the 3D model of this piece of furniture.
java.lang.String	getName() Returns the name of this piece of furniture.
Content	getPlanIcon() Returns the icon of this piece of furniture displayed in plan or null.
java.math.BigDecimal	getPrice() Returns the price of this piece of furniture or null.
java.lang.String	getProperty(java.lang.String name) Returns the value of an additional property name of this piece.
java.util.Collection<java.lang.String>	getPropertyNames() Returns the names of the additional properties of this piece.
java.lang.String	getStaircaseCutOutShape() Returns the shape used to cut out upper levels when they intersect with the piece like a staircase.
java.lang.String[]	getTags() Returns the tags associated to this piece.
java.math.BigDecimal	getValueAddedTaxPercentage() Returns the Value Added Tax percentage applied to the price of this piece of furniture.
float	getWidth() Returns the width of this piece of furniture.
int	hashCode() Returns default hash code.
boolean	isBackFaceShown() Returns true if the back face of the piece of furniture model should be displayed.
boolean	isContentProperty(java.lang.String name) Returns true if the type of given additional property is a content.
boolean	isDeformable() Returns true if this piece is deformable.
boolean	isDoorOrWindow() Returns true if this piece of furniture is a door or a window.
boolean	isHorizontallyRotatable() Returns false if this piece should not rotate around an horizontal axis.
boolean	isModifiable() Returns true if this piece is modifiable (not read from resources).
boolean	isMovable() Returns true if this piece of furniture is movable.
boolean	isProportional() Returns true if size proportions should be kept.
boolean	isResizable() Returns true if this piece is resizable.
boolean	isTexturable() Returns false if this piece should always keep the same color or texture.
boolean	isWidthDepthDeformable() Returns true if this piece is deformable.
boolean	matchesFilter(java.lang.String filter) Returns true if this piece matches the given filter text.

Methods inherited from class java.lang.Object

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

Constructor Detail

CatalogPieceOfFurniture

public CatalogPieceOfFurniture(java.lang.String name,
                               Content icon,
                               Content model,
                               float width,
                               float depth,
                               float height,
                               boolean movable,
                               boolean doorOrWindow)

Deprecated. As of version 1.7, use constructor without doorOrWindow parameter since a catalog door and window is supposed to be an instance of CatalogDoorOrWindow

Creates a catalog piece of furniture.

Parameters:

name - the name of the new piece

icon - content of the icon of the new piece

model - content of the 3D model of the new piece

width - the width in centimeters of the new piece

depth - the depth in centimeters of the new piece

height - the height in centimeters of the new piece

movable - if true, the new piece is movable

doorOrWindow - if true, the new piece is a door or a window

CatalogPieceOfFurniture

public CatalogPieceOfFurniture(java.lang.String id,
                               java.lang.String name,
                               java.lang.String description,
                               Content icon,
                               Content model,
                               float width,
                               float depth,
                               float height,
                               float elevation,
                               boolean movable,
                               boolean doorOrWindow,
                               float[][] modelRotation,
                               java.lang.String creator,
                               boolean resizable,
                               java.math.BigDecimal price,
                               java.math.BigDecimal valueAddedTaxPercentage)

Deprecated. As of version 1.7, use constructor without doorOrWindow parameter since a catalog door and window is supposed to be an instance of CatalogDoorOrWindow

Creates an unmodifiable catalog piece of furniture of the default catalog.

Parameters:

id - the id of the new piece or null

name - the name of the new piece

description - the description of the new piece

icon - content of the icon of the new piece

model - content of the 3D model of the new piece

width - the width in centimeters of the new piece

depth - the depth in centimeters of the new piece

height - the height in centimeters of the new piece

elevation - the elevation in centimeters of the new piece

movable - if true, the new piece is movable

doorOrWindow - if true, the new piece is a door or a window

modelRotation - the rotation 3 by 3 matrix applied to the piece model

creator - the creator of the model

resizable - if true, the size of the new piece may be edited

price - the price of the new piece or null

valueAddedTaxPercentage - the Value Added Tax percentage applied to the price of the new piece or null

CatalogPieceOfFurniture

public CatalogPieceOfFurniture(java.lang.String id,
                               java.lang.String name,
                               java.lang.String description,
                               Content icon,
                               Content model,
                               float width,
                               float depth,
                               float height,
                               float elevation,
                               boolean movable,
                               float[][] modelRotation,
                               java.lang.String creator,
                               boolean resizable,
                               java.math.BigDecimal price,
                               java.math.BigDecimal valueAddedTaxPercentage)

Creates an unmodifiable catalog piece of furniture of the default catalog.

Parameters:

id - the id of the new piece or null

name - the name of the new piece

description - the description of the new piece

icon - content of the icon of the new piece

model - content of the 3D model of the new piece

width - the width in centimeters of the new piece

depth - the depth in centimeters of the new piece

height - the height in centimeters of the new piece

elevation - the elevation in centimeters of the new piece

movable - if true, the new piece is movable

modelRotation - the rotation 3 by 3 matrix applied to the piece model

creator - the creator of the model

resizable - if true, the size of the new piece may be edited

price - the price of the new piece or null

valueAddedTaxPercentage - the Value Added Tax percentage applied to the price of the new piece or null

Since:

1.7

CatalogPieceOfFurniture

public CatalogPieceOfFurniture(java.lang.String id,
                               java.lang.String name,
                               java.lang.String description,
                               Content icon,
                               Content planIcon,
                               Content model,
                               float width,
                               float depth,
                               float height,
                               float elevation,
                               boolean movable,
                               float[][] modelRotation,
                               java.lang.String creator,
                               boolean resizable,
                               java.math.BigDecimal price,
                               java.math.BigDecimal valueAddedTaxPercentage)

Creates an unmodifiable catalog piece of furniture of the default catalog.

Parameters:

id - the id of the new piece or null

name - the name of the new piece

description - the description of the new piece

icon - content of the icon of the new piece

planIcon - content of the icon of the new piece displayed in plan

model - content of the 3D model of the new piece

width - the width in centimeters of the new piece

depth - the depth in centimeters of the new piece

height - the height in centimeters of the new piece

elevation - the elevation in centimeters of the new piece

movable - if true, the new piece is movable

modelRotation - the rotation 3 by 3 matrix applied to the piece model

creator - the creator of the model

resizable - if true, the size of the new piece may be edited

price - the price of the new piece or null

valueAddedTaxPercentage - the Value Added Tax percentage applied to the price of the new piece or null

Since:

2.2

CatalogPieceOfFurniture

public CatalogPieceOfFurniture(java.lang.String id,
                               java.lang.String name,
                               java.lang.String description,
                               Content icon,
                               Content planIcon,
                               Content model,
                               float width,
                               float depth,
                               float height,
                               float elevation,
                               boolean movable,
                               float[][] modelRotation,
                               java.lang.String creator,
                               boolean resizable,
                               boolean deformable,
                               boolean texturable,
                               java.math.BigDecimal price,
                               java.math.BigDecimal valueAddedTaxPercentage)

Creates an unmodifiable catalog piece of furniture of the default catalog.

Parameters:

id - the id of the new piece or null

name - the name of the new piece

description - the description of the new piece

icon - content of the icon of the new piece

planIcon - content of the icon of the new piece displayed in plan

model - content of the 3D model of the new piece

width - the width in centimeters of the new piece

depth - the depth in centimeters of the new piece

height - the height in centimeters of the new piece

elevation - the elevation in centimeters of the new piece

movable - if true, the new piece is movable

modelRotation - the rotation 3 by 3 matrix applied to the piece model

creator - the creator of the model

resizable - if true, the size of the new piece may be edited

deformable - if true, the width, depth and height of the new piece may change independently from each other

texturable - if false this piece should always keep the same color or texture.

price - the price of the new piece or null

valueAddedTaxPercentage - the Value Added Tax percentage applied to the price of the new piece or null

Since:

3.0

CatalogPieceOfFurniture

public CatalogPieceOfFurniture(java.lang.String id,
                               java.lang.String name,
                               java.lang.String description,
                               Content icon,
                               Content planIcon,
                               Content model,
                               float width,
                               float depth,
                               float height,
                               float elevation,
                               boolean movable,
                               java.lang.String staircaseCutOutShape,
                               float[][] modelRotation,
                               java.lang.String creator,
                               boolean resizable,
                               boolean deformable,
                               boolean texturable,
                               java.math.BigDecimal price,
                               java.math.BigDecimal valueAddedTaxPercentage,
                               java.lang.String currency)

Creates an unmodifiable catalog piece of furniture of the default catalog.

Parameters:

id - the id of the new piece or null

name - the name of the new piece

description - the description of the new piece

icon - content of the icon of the new piece

planIcon - content of the icon of the new piece displayed in plan

model - content of the 3D model of the new piece

width - the width in centimeters of the new piece

depth - the depth in centimeters of the new piece

height - the height in centimeters of the new piece

elevation - the elevation in centimeters of the new piece

movable - if true, the new piece is movable

staircaseCutOutShape - the shape used to cut out upper levels when they intersect with the piece like a staircase

modelRotation - the rotation 3 by 3 matrix applied to the piece model

creator - the creator of the model

resizable - if true, the size of the new piece may be edited

deformable - if true, the width, depth and height of the new piece may change independently from each other

texturable - if false this piece should always keep the same color or texture.

price - the price of the new piece or null

valueAddedTaxPercentage - the Value Added Tax percentage applied to the price of the new piece or null

currency - the price currency, noted with ISO 4217 code, or null

Since:

3.4

CatalogPieceOfFurniture

public CatalogPieceOfFurniture(java.lang.String id,
                               java.lang.String name,
                               java.lang.String description,
                               java.lang.String information,
                               java.lang.String[] tags,
                               java.lang.Long creationDate,
                               java.lang.Float grade,
                               Content icon,
                               Content planIcon,
                               Content model,
                               float width,
                               float depth,
                               float height,
                               float elevation,
                               boolean movable,
                               java.lang.String staircaseCutOutShape,
                               float[][] modelRotation,
                               java.lang.String creator,
                               boolean resizable,
                               boolean deformable,
                               boolean texturable,
                               java.math.BigDecimal price,
                               java.math.BigDecimal valueAddedTaxPercentage,
                               java.lang.String currency)

Creates an unmodifiable catalog piece of furniture of the default catalog.

Parameters:

id - the id of the new piece or null

name - the name of the new piece

description - the description of the new piece

information - additional information associated to the new piece

tags - tags associated to the new piece

creationDate - creation date of the new piece in milliseconds since the epoch

grade - grade of the piece of furniture or null

icon - content of the icon of the new piece

planIcon - content of the icon of the new piece displayed in plan

model - content of the 3D model of the new piece

width - the width in centimeters of the new piece

depth - the depth in centimeters of the new piece

height - the height in centimeters of the new piece

elevation - the elevation in centimeters of the new piece

movable - if true, the new piece is movable

staircaseCutOutShape - the shape used to cut out upper levels when they intersect with the piece like a staircase

modelRotation - the rotation 3 by 3 matrix applied to the piece model

creator - the creator of the model

resizable - if true, the size of the new piece may be edited

deformable - if true, the width, depth and height of the new piece may change independently from each other

texturable - if false this piece should always keep the same color or texture.

price - the price of the new piece or null

valueAddedTaxPercentage - the Value Added Tax percentage applied to the price of the new piece or null

currency - the price currency, noted with ISO 4217 code, or null

Since:

3.6

CatalogPieceOfFurniture

public CatalogPieceOfFurniture(java.lang.String id,
                               java.lang.String name,
                               java.lang.String description,
                               java.lang.String information,
                               java.lang.String[] tags,
                               java.lang.Long creationDate,
                               java.lang.Float grade,
                               Content icon,
                               Content planIcon,
                               Content model,
                               float width,
                               float depth,
                               float height,
                               float elevation,
                               float dropOnTopElevation,
                               boolean movable,
                               java.lang.String staircaseCutOutShape,
                               float[][] modelRotation,
                               java.lang.String creator,
                               boolean resizable,
                               boolean deformable,
                               boolean texturable,
                               java.math.BigDecimal price,
                               java.math.BigDecimal valueAddedTaxPercentage,
                               java.lang.String currency)

Creates an unmodifiable catalog piece of furniture of the default catalog.

Parameters:

id - the id of the new piece or null

name - the name of the new piece

description - the description of the new piece

information - additional information associated to the new piece

tags - tags associated to the new piece

creationDate - creation date of the new piece in milliseconds since the epoch

grade - grade of the piece of furniture or null

icon - content of the icon of the new piece

planIcon - content of the icon of the new piece displayed in plan

model - content of the 3D model of the new piece

width - the width in centimeters of the new piece

depth - the depth in centimeters of the new piece

height - the height in centimeters of the new piece

elevation - the elevation in centimeters of the new piece

dropOnTopElevation - a percentage of the height at which should be placed an object dropped on the new piece

movable - if true, the new piece is movable

staircaseCutOutShape - the shape used to cut out upper levels when they intersect with the piece like a staircase

modelRotation - the rotation 3 by 3 matrix applied to the piece model

creator - the creator of the model

resizable - if true, the size of the new piece may be edited

deformable - if true, the width, depth and height of the new piece may change independently from each other

texturable - if false this piece should always keep the same color or texture.

price - the price of the new piece or null

valueAddedTaxPercentage - the Value Added Tax percentage applied to the price of the new piece or null

currency - the price currency, noted with ISO 4217 code, or null

Since:

4.4

CatalogPieceOfFurniture

public CatalogPieceOfFurniture(java.lang.String id,
                               java.lang.String name,
                               java.lang.String description,
                               java.lang.String information,
                               java.lang.String[] tags,
                               java.lang.Long creationDate,
                               java.lang.Float grade,
                               Content icon,
                               Content planIcon,
                               Content model,
                               float width,
                               float depth,
                               float height,
                               float elevation,
                               float dropOnTopElevation,
                               boolean movable,
                               java.lang.String staircaseCutOutShape,
                               float[][] modelRotation,
                               boolean backFaceShown,
                               java.lang.String creator,
                               boolean resizable,
                               boolean deformable,
                               boolean texturable,
                               java.math.BigDecimal price,
                               java.math.BigDecimal valueAddedTaxPercentage,
                               java.lang.String currency)

Creates an unmodifiable catalog piece of furniture of the default catalog.

Parameters:

id - the id of the new piece or null

name - the name of the new piece

description - the description of the new piece

information - additional information associated to the new piece

tags - tags associated to the new piece

creationDate - creation date of the new piece in milliseconds since the epoch

grade - grade of the piece of furniture or null

icon - content of the icon of the new piece

planIcon - content of the icon of the new piece displayed in plan

model - content of the 3D model of the new piece

width - the width in centimeters of the new piece

depth - the depth in centimeters of the new piece

height - the height in centimeters of the new piece

elevation - the elevation in centimeters of the new piece

dropOnTopElevation - a percentage of the height at which should be placed an object dropped on the new piece

movable - if true, the new piece is movable

staircaseCutOutShape - the shape used to cut out upper levels when they intersect with the piece like a staircase

modelRotation - the rotation 3 by 3 matrix applied to the piece model

backFaceShown - true if back face should be shown instead of front faces

creator - the creator of the model

resizable - if true, the size of the new piece may be edited

deformable - if true, the width, depth and height of the new piece may change independently from each other

texturable - if false this piece should always keep the same color or texture.

price - the price of the new piece or null

valueAddedTaxPercentage - the Value Added Tax percentage applied to the price of the new piece or null

currency - the price currency, noted with ISO 4217 code, or null

Since:

5.3

CatalogPieceOfFurniture

public CatalogPieceOfFurniture(java.lang.String id,
                               java.lang.String name,
                               java.lang.String description,
                               java.lang.String information,
                               java.lang.String[] tags,
                               java.lang.Long creationDate,
                               java.lang.Float grade,
                               Content icon,
                               Content planIcon,
                               Content model,
                               float width,
                               float depth,
                               float height,
                               float elevation,
                               float dropOnTopElevation,
                               boolean movable,
                               java.lang.String staircaseCutOutShape,
                               float[][] modelRotation,
                               boolean backFaceShown,
                               java.lang.Long modelSize,
                               java.lang.String creator,
                               boolean resizable,
                               boolean deformable,
                               boolean texturable,
                               boolean horizontallyRotatable,
                               java.math.BigDecimal price,
                               java.math.BigDecimal valueAddedTaxPercentage,
                               java.lang.String currency)

Creates an unmodifiable catalog piece of furniture of the default catalog.

Parameters:

id - the id of the new piece or null

name - the name of the new piece

description - the description of the new piece

information - additional information associated to the new piece

tags - tags associated to the new piece

creationDate - creation date of the new piece in milliseconds since the epoch

grade - grade of the piece of furniture or null

icon - content of the icon of the new piece

planIcon - content of the icon of the new piece displayed in plan

model - content of the 3D model of the new piece

width - the width in centimeters of the new piece

depth - the depth in centimeters of the new piece

height - the height in centimeters of the new piece

elevation - the elevation in centimeters of the new piece

dropOnTopElevation - a percentage of the height at which should be placed an object dropped on the new piece

movable - if true, the new piece is movable

staircaseCutOutShape - the shape used to cut out upper levels when they intersect with the piece like a staircase

modelRotation - the rotation 3 by 3 matrix applied to the piece model

backFaceShown - true if back face should be shown instead of front faces

modelSize - size of the 3D model of the new piece

creator - the creator of the model

resizable - if true, the size of the new piece may be edited

deformable - if true, the width, depth and height of the new piece may change independently from each other

texturable - if false this piece should always keep the same color or texture

horizontallyRotatable - if false this piece should not rotate around an horizontal axis

price - the price of the new piece or null

valueAddedTaxPercentage - the Value Added Tax percentage applied to the price of the new piece or null

currency - the price currency, noted with ISO 4217 code, or null

Since:

5.5

CatalogPieceOfFurniture

public CatalogPieceOfFurniture(java.lang.String id,
                               java.lang.String name,
                               java.lang.String description,
                               java.lang.String information,
                               java.lang.String[] tags,
                               java.lang.Long creationDate,
                               java.lang.Float grade,
                               Content icon,
                               Content planIcon,
                               Content model,
                               float width,
                               float depth,
                               float height,
                               float elevation,
                               float dropOnTopElevation,
                               boolean movable,
                               java.lang.String staircaseCutOutShape,
                               float[][] modelRotation,
                               boolean backFaceShown,
                               java.lang.Long modelSize,
                               java.lang.String creator,
                               boolean resizable,
                               boolean deformable,
                               boolean texturable,
                               boolean horizontallyRotatable,
                               java.math.BigDecimal price,
                               java.math.BigDecimal valueAddedTaxPercentage,
                               java.lang.String currency,
                               java.util.Map<java.lang.String,java.lang.String> properties)

Creates an unmodifiable catalog piece of furniture of the default catalog.

Parameters:

id - the id of the new piece or null

name - the name of the new piece

description - the description of the new piece

information - additional information associated to the new piece

tags - tags associated to the new piece

creationDate - creation date of the new piece in milliseconds since the epoch

grade - grade of the piece of furniture or null

icon - content of the icon of the new piece

planIcon - content of the icon of the new piece displayed in plan

model - content of the 3D model of the new piece

width - the width in centimeters of the new piece

depth - the depth in centimeters of the new piece

height - the height in centimeters of the new piece

elevation - the elevation in centimeters of the new piece

dropOnTopElevation - a percentage of the height at which should be placed an object dropped on the new piece

movable - if true, the new piece is movable

staircaseCutOutShape - the shape used to cut out upper levels when they intersect with the piece like a staircase

modelRotation - the rotation 3 by 3 matrix applied to the piece model

backFaceShown - true if back face should be shown instead of front faces

modelSize - size of the 3D model of the new piece

creator - the creator of the model

resizable - if true, the size of the new piece may be edited

deformable - if true, the width, depth and height of the new piece may change independently from each other

texturable - if false this piece should always keep the same color or texture

horizontallyRotatable - if false this piece should not rotate around an horizontal axis

price - the price of the new piece or null

valueAddedTaxPercentage - the Value Added Tax percentage applied to the price of the new piece or null

currency - the price currency, noted with ISO 4217 code, or null

properties - additional properties associating a key to a value or null

Since:

5.7

CatalogPieceOfFurniture

public CatalogPieceOfFurniture(java.lang.String id,
                               java.lang.String name,
                               java.lang.String description,
                               java.lang.String information,
                               java.lang.String[] tags,
                               java.lang.Long creationDate,
                               java.lang.Float grade,
                               Content icon,
                               Content planIcon,
                               Content model,
                               float width,
                               float depth,
                               float height,
                               float elevation,
                               float dropOnTopElevation,
                               boolean movable,
                               java.lang.String staircaseCutOutShape,
                               float[][] modelRotation,
                               int modelFlags,
                               java.lang.Long modelSize,
                               java.lang.String creator,
                               boolean resizable,
                               boolean deformable,
                               boolean texturable,
                               boolean horizontallyRotatable,
                               java.math.BigDecimal price,
                               java.math.BigDecimal valueAddedTaxPercentage,
                               java.lang.String currency,
                               java.util.Map<java.lang.String,java.lang.String> properties)

Creates an unmodifiable catalog piece of furniture of the default catalog.

Parameters:

id - the id of the new piece or null

name - the name of the new piece

description - the description of the new piece

information - additional information associated to the new piece

tags - tags associated to the new piece

creationDate - creation date of the new piece in milliseconds since the epoch

grade - grade of the piece of furniture or null

icon - content of the icon of the new piece

planIcon - content of the icon of the new piece displayed in plan

model - content of the 3D model of the new piece

width - the width in centimeters of the new piece

depth - the depth in centimeters of the new piece

height - the height in centimeters of the new piece

elevation - the elevation in centimeters of the new piece

dropOnTopElevation - a percentage of the height at which should be placed an object dropped on the new piece

movable - if true, the new piece is movable

staircaseCutOutShape - the shape used to cut out upper levels when they intersect with the piece like a staircase

modelRotation - the rotation 3 by 3 matrix applied to the piece model

modelFlags - flags which should be applied to piece model

modelSize - size of the 3D model of the new piece

creator - the creator of the model

resizable - if true, the size of the new piece may be edited

deformable - if true, the width, depth and height of the new piece may change independently from each other

texturable - if false this piece should always keep the same color or texture

horizontallyRotatable - if false this piece should not rotate around an horizontal axis

price - the price of the new piece or null

valueAddedTaxPercentage - the Value Added Tax percentage applied to the price of the new piece or null

currency - the price currency, noted with ISO 4217 code, or null

properties - additional properties associating a key to a value or null

Since:

7.0

CatalogPieceOfFurniture

public CatalogPieceOfFurniture(java.lang.String id,
                               java.lang.String name,
                               java.lang.String description,
                               java.lang.String information,
                               java.lang.String license,
                               java.lang.String[] tags,
                               java.lang.Long creationDate,
                               java.lang.Float grade,
                               Content icon,
                               Content planIcon,
                               Content model,
                               float width,
                               float depth,
                               float height,
                               float elevation,
                               float dropOnTopElevation,
                               boolean movable,
                               java.lang.String staircaseCutOutShape,
                               float[][] modelRotation,
                               int modelFlags,
                               java.lang.Long modelSize,
                               java.lang.String creator,
                               boolean resizable,
                               boolean deformable,
                               boolean texturable,
                               boolean horizontallyRotatable,
                               java.math.BigDecimal price,
                               java.math.BigDecimal valueAddedTaxPercentage,
                               java.lang.String currency,
                               java.util.Map<java.lang.String,java.lang.String> properties,
                               java.util.Map<java.lang.String,Content> contents)

Creates an unmodifiable catalog piece of furniture of the default catalog.

Parameters:

id - the id of the new piece or null

name - the name of the new piece

description - the description of the new piece

information - additional information associated to the new piece

license - license of the new piece

tags - tags associated to the new piece

creationDate - creation date of the new piece in milliseconds since the epoch

grade - grade of the piece of furniture or null

icon - content of the icon of the new piece

planIcon - content of the icon of the new piece displayed in plan

model - content of the 3D model of the new piece

width - the width in centimeters of the new piece

depth - the depth in centimeters of the new piece

height - the height in centimeters of the new piece

elevation - the elevation in centimeters of the new piece

dropOnTopElevation - a percentage of the height at which should be placed an object dropped on the new piece

movable - if true, the new piece is movable

staircaseCutOutShape - the shape used to cut out upper levels when they intersect with the piece like a staircase

modelRotation - the rotation 3 by 3 matrix applied to the piece model

modelFlags - flags which should be applied to piece model

modelSize - size of the 3D model of the new piece

creator - the creator of the model

resizable - if true, the size of the new piece may be edited

deformable - if true, the width, depth and height of the new piece may change independently from each other

texturable - if false this piece should always keep the same color or texture

horizontallyRotatable - if false this piece should not rotate around an horizontal axis

price - the price of the new piece or null

valueAddedTaxPercentage - the Value Added Tax percentage applied to the price of the new piece or null

currency - the price currency, noted with ISO 4217 code, or null

properties - additional properties associating a key to a value or null

contents - additional contents associating a key to a value or null

Since:

7.2

CatalogPieceOfFurniture

public CatalogPieceOfFurniture(java.lang.String name,
                               Content icon,
                               Content model,
                               float width,
                               float depth,
                               float height,
                               float elevation,
                               boolean movable,
                               boolean doorOrWindow,
                               java.lang.Integer color,
                               float[][] modelRotation,
                               boolean backFaceShown,
                               float iconYaw,
                               boolean proportional)

Deprecated. As of version 1.7, use constructor without doorOrWindow parameter since a catalog door and window is supposed to be an instance of CatalogDoorOrWindow

Creates a modifiable catalog piece of furniture with all its values.

Parameters:

name - the name of the new piece

icon - content of the icon of the new piece

model - content of the 3D model of the new piece

width - the width in centimeters of the new piece

depth - the depth in centimeters of the new piece

height - the height in centimeters of the new piece

elevation - the elevation in centimeters of the new piece

movable - if true, the new piece is movable

doorOrWindow - if true, the new piece is a door or a window

color - the color of the piece as RGB code or null if piece color is unchanged

modelRotation - the rotation 3 by 3 matrix applied to the piece model

backFaceShown - true if back face should be shown instead of front faces

iconYaw - the yaw angle used to create the piece icon

proportional - if true, size proportions will be kept

CatalogPieceOfFurniture

public CatalogPieceOfFurniture(java.lang.String name,
                               Content icon,
                               Content model,
                               float width,
                               float depth,
                               float height,
                               float elevation,
                               boolean movable,
                               java.lang.Integer color,
                               float[][] modelRotation,
                               boolean backFaceShown,
                               float iconYaw,
                               boolean proportional)

Creates a modifiable catalog piece of furniture with all its values.

Parameters:

name - the name of the new piece

icon - content of the icon of the new piece

model - content of the 3D model of the new piece

width - the width in centimeters of the new piece

depth - the depth in centimeters of the new piece

height - the height in centimeters of the new piece

elevation - the elevation in centimeters of the new piece

movable - if true, the new piece is movable

color - the color of the piece as RGB code or null if piece color is unchanged

modelRotation - the rotation 3 by 3 matrix applied to the piece model

backFaceShown - true if back face should be shown

iconYaw - the yaw angle used to create the piece icon

proportional - if true, size proportions will be kept

Since:

1.7

CatalogPieceOfFurniture

public CatalogPieceOfFurniture(java.lang.String name,
                               Content icon,
                               Content model,
                               float width,
                               float depth,
                               float height,
                               float elevation,
                               boolean movable,
                               java.lang.String staircaseCutOutShape,
                               java.lang.Integer color,
                               float[][] modelRotation,
                               boolean backFaceShown,
                               float iconYaw,
                               boolean proportional)

Creates a modifiable catalog piece of furniture with all its values.

Parameters:

name - the name of the new piece

icon - content of the icon of the new piece

model - content of the 3D model of the new piece

width - the width in centimeters of the new piece

depth - the depth in centimeters of the new piece

height - the height in centimeters of the new piece

elevation - the elevation in centimeters of the new piece

movable - if true, the new piece is movable

staircaseCutOutShape - the shape used to cut out upper levels when they intersect with the piece like a staircase

color - the color of the piece as RGB code or null if piece color is unchanged

modelRotation - the rotation 3 by 3 matrix applied to the piece model

backFaceShown - true if back face should be shown

iconYaw - the yaw angle used to create the piece icon

proportional - if true, size proportions will be kept

Since:

3.4

CatalogPieceOfFurniture

public CatalogPieceOfFurniture(java.lang.String name,
                               Content icon,
                               Content model,
                               float width,
                               float depth,
                               float height,
                               float elevation,
                               boolean movable,
                               java.lang.String staircaseCutOutShape,
                               java.lang.Integer color,
                               float[][] modelRotation,
                               boolean backFaceShown,
                               java.lang.Long modelSize,
                               java.lang.String creator,
                               float iconYaw,
                               boolean proportional)

Creates a modifiable catalog piece of furniture with all its values.

Parameters:

name - the name of the new piece

icon - content of the icon of the new piece

model - content of the 3D model of the new piece

width - the width in centimeters of the new piece

depth - the depth in centimeters of the new piece

height - the height in centimeters of the new piece

elevation - the elevation in centimeters of the new piece

movable - if true, the new piece is movable

staircaseCutOutShape - the shape used to cut out upper levels when they intersect with the piece like a staircase

color - the color of the piece as RGB code or null if piece color is unchanged

modelRotation - the rotation 3 by 3 matrix applied to the piece model

backFaceShown - true if back face should be shown

modelSize - size of the 3D model of the new piece

creator - the creator of the model

iconYaw - the yaw angle used to create the piece icon

proportional - if true, size proportions will be kept

Since:

5.5

CatalogPieceOfFurniture

public CatalogPieceOfFurniture(java.lang.String name,
                               Content icon,
                               Content model,
                               float width,
                               float depth,
                               float height,
                               float elevation,
                               boolean movable,
                               java.lang.String staircaseCutOutShape,
                               java.lang.Integer color,
                               float[][] modelRotation,
                               int modelFlags,
                               java.lang.Long modelSize,
                               java.lang.String creator,
                               float iconYaw,
                               float iconPitch,
                               float iconScale,
                               boolean proportional)

Creates a modifiable catalog piece of furniture with all its values.

Parameters:

name - the name of the new piece

icon - content of the icon of the new piece

model - content of the 3D model of the new piece

width - the width in centimeters of the new piece

depth - the depth in centimeters of the new piece

height - the height in centimeters of the new piece

elevation - the elevation in centimeters of the new piece

movable - if true, the new piece is movable

staircaseCutOutShape - the shape used to cut out upper levels when they intersect with the piece like a staircase

color - the color of the piece as RGB code or null if piece color is unchanged

modelRotation - the rotation 3 by 3 matrix applied to the piece model

modelFlags - flags which should be applied to piece model

modelSize - size of the 3D model of the new piece

creator - the creator of the model

iconYaw - the yaw angle used to create the piece icon

iconPitch - the pich angle used to create the piece icon

iconScale - the scale used to create the piece icon

proportional - if true, size proportions will be kept

Since:

7.0

Method Detail

getId

public java.lang.String getId()

Returns the ID of this piece of furniture or null.

getName

public java.lang.String getName()

Returns the name of this piece of furniture.

Specified by:

getName in interface CatalogItem

Specified by:

getName in interface PieceOfFurniture

getDescription

public java.lang.String getDescription()

Returns the description of this piece of furniture. The returned value may be null.

Specified by:

getDescription in interface PieceOfFurniture

getInformation

public java.lang.String getInformation()

Returns the additional information associated to this piece, or null.

Specified by:

getInformation in interface PieceOfFurniture

Since:

3.6

getLicense

public java.lang.String getLicense()

Returns the license associated to this piece, or null.

Specified by:

getLicense in interface PieceOfFurniture

Since:

7.2

getTags

public java.lang.String[] getTags()

Returns the tags associated to this piece.

Since:

3.6

getCreationDate

public java.lang.Long getCreationDate()

Returns the creation date of this piece in milliseconds since the epoch, or null if no date is given to this piece.

Since:

3.6

getGrade

public java.lang.Float getGrade()

Returns the grade of this piece, or null if no grade is given to this piece.

Since:

3.6

getDepth

public float getDepth()

Returns the depth of this piece of furniture.

Specified by:

getDepth in interface PieceOfFurniture

getHeight

public float getHeight()

Returns the height of this piece of furniture.

Specified by:

getHeight in interface PieceOfFurniture

getWidth

public float getWidth()

Returns the width of this piece of furniture.

Specified by:

getWidth in interface PieceOfFurniture

getElevation

public float getElevation()

Returns the elevation of this piece of furniture.

Specified by:

getElevation in interface PieceOfFurniture

getDropOnTopElevation

public float getDropOnTopElevation()

Returns the elevation at which should be placed an object dropped on this piece.

Specified by:

getDropOnTopElevation in interface PieceOfFurniture

Returns:

a percentage of the height of this piece. A negative value means that the piece should be ignored when an object is dropped on it.

Since:

4.4

isMovable

public boolean isMovable()

Returns true if this piece of furniture is movable.

Specified by:

isMovable in interface PieceOfFurniture

isDoorOrWindow

public boolean isDoorOrWindow()

Returns true if this piece of furniture is a door or a window. As this method existed before CatalogDoorOrWindow class, you shouldn't rely on the value returned by this method to guess if a piece is an instance of DoorOrWindow class.

Specified by:

isDoorOrWindow in interface PieceOfFurniture

getIcon

public Content getIcon()

Returns the icon of this piece of furniture.

Specified by:

getIcon in interface CatalogItem

Specified by:

getIcon in interface PieceOfFurniture

getPlanIcon

public Content getPlanIcon()

Returns the icon of this piece of furniture displayed in plan or null.

Specified by:

getPlanIcon in interface PieceOfFurniture

Since:

2.2

getModel

public Content getModel()

Returns the 3D model of this piece of furniture.

Specified by:

getModel in interface PieceOfFurniture

getModelFlags

public int getModelFlags()

Returns the flags which should be applied to the 3D model of this piece of furniture.

Specified by:

getModelFlags in interface PieceOfFurniture

Since:

7.0

getModelSize

public java.lang.Long getModelSize()

Returns the size of the 3D model of this piece of furniture.

Specified by:

getModelSize in interface PieceOfFurniture

Since:

5.5

getModelRotation

public float[][] getModelRotation()

Returns the rotation 3 by 3 matrix of this piece of furniture that ensures its model is correctly oriented.

Specified by:

getModelRotation in interface PieceOfFurniture

getStaircaseCutOutShape

public java.lang.String getStaircaseCutOutShape()

Returns the shape used to cut out upper levels when they intersect with the piece like a staircase.

Specified by:

getStaircaseCutOutShape in interface PieceOfFurniture

Since:

3.4

getCreator

public java.lang.String getCreator()

Returns the creator of this piece.

Specified by:

getCreator in interface CatalogItem

Specified by:

getCreator in interface PieceOfFurniture

isBackFaceShown

public boolean isBackFaceShown()

Returns true if the back face of the piece of furniture model should be displayed.

Specified by:

isBackFaceShown in interface PieceOfFurniture

getColor

public java.lang.Integer getColor()

Returns the color of this piece of furniture.

Specified by:

getColor in interface PieceOfFurniture

getIconYaw

public float getIconYaw()

Returns the yaw angle used to create the piece icon.

getIconPitch

public float getIconPitch()

Returns the pitch angle used to create the piece icon.

Since:

7.0

getIconScale

public float getIconScale()

Returns the scale used to create the piece icon.

Since:

7.0

isProportional

public boolean isProportional()

Returns true if size proportions should be kept.

isModifiable

public boolean isModifiable()

Returns true if this piece is modifiable (not read from resources).

isResizable

public boolean isResizable()

Returns true if this piece is resizable.

Specified by:

isResizable in interface PieceOfFurniture

isDeformable

public boolean isDeformable()

Returns true if this piece is deformable.

Specified by:

isDeformable in interface PieceOfFurniture

Since:

3.0

isWidthDepthDeformable

public boolean isWidthDepthDeformable()

Returns true if this piece is deformable.

Specified by:

isWidthDepthDeformable in interface PieceOfFurniture

Since:

5.5

isTexturable

public boolean isTexturable()

Returns false if this piece should always keep the same color or texture.

Specified by:

isTexturable in interface PieceOfFurniture

Since:

3.0

isHorizontallyRotatable

public boolean isHorizontallyRotatable()

Returns false if this piece should not rotate around an horizontal axis.

Specified by:

isHorizontallyRotatable in interface PieceOfFurniture

Since:

5.5

getPrice

public java.math.BigDecimal getPrice()

Returns the price of this piece of furniture or null.

Specified by:

getPrice in interface PieceOfFurniture

getValueAddedTaxPercentage

public java.math.BigDecimal getValueAddedTaxPercentage()

Returns the Value Added Tax percentage applied to the price of this piece of furniture.

Specified by:

getValueAddedTaxPercentage in interface PieceOfFurniture

getCurrency

public java.lang.String getCurrency()

Returns the price currency, noted with ISO 4217 code, or null if it has no price or default currency should be used.

Specified by:

getCurrency in interface PieceOfFurniture

Since:

3.4

getProperty

public java.lang.String getProperty(java.lang.String name)

Returns the value of an additional property name of this piece.

Specified by:

getProperty in interface PieceOfFurniture

Returns:

the value of the property or null if it doesn't exist or if it's not a string.

getPropertyNames

public java.util.Collection<java.lang.String> getPropertyNames()

Returns the names of the additional properties of this piece.

Specified by:

getPropertyNames in interface PieceOfFurniture

Returns:

a collection of all the names of the properties

getContentProperty

public Content getContentProperty(java.lang.String name)

Returns the value of an additional content name associated to this piece.

Specified by:

getContentProperty in interface PieceOfFurniture

Returns:

the value of the content or null if it doesn't exist or if it's not a content.

Since:

7.2

isContentProperty

public boolean isContentProperty(java.lang.String name)

Returns true if the type of given additional property is a content.

Specified by:

isContentProperty in interface PieceOfFurniture

Since:

7.2

getCategory

public FurnitureCategory getCategory()

Returns the category of this piece of furniture.

equals

public boolean equals(java.lang.Object obj)

Returns true if this piece and the one in parameter are the same objects. Note that, from version 3.6, two pieces of furniture can have the same name.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Returns default hash code.

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(CatalogPieceOfFurniture piece)

Compares the names of this piece and the one in parameter.

Specified by:

compareTo in interface java.lang.Comparable<CatalogPieceOfFurniture>

matchesFilter

public boolean matchesFilter(java.lang.String filter)

Returns true if this piece matches the given filter text. Each substring of the filter is considered as a search criterion that can match the name, the category name, the creator, the license, the description or the tags of this piece.

Since:

4.2

getFilterCriteria

protected java.lang.String[] getFilterCriteria()

Returns the strings used as criteria for filtering (name, category, creator, license, description and tags).

Since:

6.2

See Also:

matchesFilter(String)

clone

public CatalogPieceOfFurniture clone()

Returns a clone of this piece.

Overrides:

clone in class java.lang.Object

Since:

5.8