ilog.cpl.table.selection
Class IlpArea

java.lang.Object
  ilog.cpl.table.selection.IlpArea

Direct Known Subclasses:

IlpAllArea

public class IlpArea
extends Object

An area defines an intersection between a set of representation objects and a set of attributes.
These sets can be empty:

• An empty set of attributes means that all attributes of the representation objects which are in the area are concerned.
• An empty set of representation objects means that the set of attributes is concerned whatever the representation objects.
• The area is considered as empty when BOTH the sets are empty.

Since:

JTGO 3.0

Constructor Summary

IlpArea()
Creates an empty area.

IlpArea(Collection ros, Collection attribs)
Creates an area with a set of representation objects and a set of attributes.

IlpArea(Collection ros, Collection attribs, boolean copy)
Creates an area with a set of representation objects and a set of attributes.

IlpArea(IlpRepresentationObject object, IlpAttribute attribute)
Creates an area representing a particular attribute of a particular representation object.

Method Summary

boolean	contains(IlpArea area) Returns true if the current area contains the given area.
boolean	contains(IlpRepresentationObject object, IlpAttribute attribute) Returns true if the current area contains the area defined by the given representation object and attribute.
boolean	equals(Object anObject) Returns false if the given object is not an instance of IlpArea or is not equal to the current area.
Collection	getAttributes() Returns the set of attributes defining this area.
IlpArea	getAttributesArea() Returns a new area that contains only the attributes.
IlpArea	getIntersection(IlpArea area) Returns an area representing the intersection of the current area and the given one.
Collection	getRepresentationObjects() Returns the set of representation objects defining this area.
IlpArea	getRepresentationObjectsArea() Returns a new area that contains only the representation objects.
boolean	isEmpty() Returns true if the set of representation objects and the set of attributes are both empty.
boolean	isSelectAll() Returns if this area represents a full selection in the table.
String	toString() Returns a description of this area as a string.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlpArea

public IlpArea()

Creates an empty area.

IlpArea

public IlpArea(IlpRepresentationObject object,
               IlpAttribute attribute)

Creates an area representing a particular attribute of a particular representation object.

Parameters:

object - The representation object defining the area; can be null.

attribute - The attribute defining the area; can be null.

IlpArea

public IlpArea(Collection ros,
               Collection attribs)

Creates an area with a set of representation objects and a set of attributes.

Parameters:

ros - The set of representation objects defining the area; can be null or empty.

attribs - The set of attributes defining the area; can be null or empty.

IlpArea

public IlpArea(Collection ros,
               Collection attribs,
               boolean copy)

Creates an area with a set of representation objects and a set of attributes.

Parameters:

ros - The set of representation objects defining the area; can be null or empty.

attribs - The set of attributes defining the area; can be null or empty.

copy - Flag that indicates if the set of representation objects and the set of attributes will be copied to the internal structures or if they will be used as is.

Since:

JViews 7.5

Method Detail

getRepresentationObjects

public Collection getRepresentationObjects()

Returns the set of representation objects defining this area. The set can be empty but not null.

Returns:

The set of representation objects defining this area.

See Also:

getAttributes()

getAttributes

public Collection getAttributes()

Returns the set of attributes defining this area. The set can be empty but not null.

Returns:

The set of attributes defining this area.

See Also:

getRepresentationObjects()

contains

public boolean contains(IlpArea area)

Returns true if the current area contains the given area.

Note: Returns true if the given area is empty or equal to null.

Parameters:

area - The area which must be contained by the current one; can be null.

Returns:

true if the current area contains the given one.

contains

public boolean contains(IlpRepresentationObject object,
                        IlpAttribute attribute)

Returns true if the current area contains the area defined by the given representation object and attribute.

Parameters:

object - The representation object defining the area; can be null.

attribute - The attribute defining the area; can be null.

Returns:

true if the current area contains the given one.

See Also:

contains(IlpArea)

isEmpty

public boolean isEmpty()

Returns true if the set of representation objects and the set of attributes are both empty.

Returns:

true if the area is empty.

getIntersection

public IlpArea getIntersection(IlpArea area)

Returns an area representing the intersection of the current area and the given one.

Parameters:

area - The area given to constitute the intersection; can be null.

Returns:

The intersection between the current area and the given one.

equals

public boolean equals(Object anObject)

Returns false if the given object is not an instance of IlpArea or is not equal to the current area.

Overrides:

equals in class Object

Parameters:

anObject - The area to check.

Returns:

Whether the given area represents the same area as the current one.

toString

public String toString()

Returns a description of this area as a string.

Overrides:

toString in class Object

Returns:

A description of this area as a string.

getAttributesArea

public IlpArea getAttributesArea()

Returns a new area that contains only the attributes.

Returns:

A new area with attributes only.

Since:

JTGO 4.0

Internal method or field: do not use!

getRepresentationObjectsArea

public IlpArea getRepresentationObjectsArea()

Returns a new area that contains only the representation objects.

Returns:

A new area with representation objects only.

Since:

JTGO 4.0

Internal method or field: do not use!

isSelectAll

public boolean isSelectAll()

Returns if this area represents a full selection in the table.

Returns:

true if this area represents the whole table

Internal method or field: do not use!