Package com.luciad.format.dwg

Class TLcdDWGBlock

java.lang.Object

com.luciad.shape.ALcdShape

com.luciad.shape.ALcdShapeList

com.luciad.shape.TLcdShapeList

com.luciad.format.dwg.TLcdDWGBlock

All Implemented Interfaces:

ILcdDataObject, ILcdDWGShape, ILcdBounded, ILcdEditableShapeList, ILcdShape, ILcdShapeList, ILcdCache, ILcdCloneable, ILcdFeatured, ILcdInvalidateable, Serializable, Cloneable

public class TLcdDWGBlock
extends TLcdShapeList
implements ILcdDWGShape

This class represents a Block from a DWG file. It extends a TLcdShapeList, in such a way that it becomes an ILcdDWGShape as well.

See Also:

• Serialized Form

Field Summary

Fields inherited from interface com.luciad.format.dwg.ILcdDWGShape

TYPE_APPID, TYPE_APPID_CONTROL, TYPE_ARC, TYPE_ATTDEF, TYPE_ATTRIB, TYPE_BLOCK, TYPE_BLOCK_CONTROL, TYPE_BLOCK_HEADER, TYPE_BODY, TYPE_CIRCLE, TYPE_DICTIONARY, TYPE_DIMENSION_ALIGNED, TYPE_DIMENSION_ANGLE_2LINE, TYPE_DIMENSION_ANGLE_3POINT, TYPE_DIMENSION_DIAMETER, TYPE_DIMENSION_LINEAR, TYPE_DIMENSION_ORDINATE, TYPE_DIMENSION_RADIUS, TYPE_DIMSTYLE, TYPE_DIMSTYLE_CONTROL, TYPE_ELLIPSE, TYPE_ENDBLK, TYPE_FACE_3D, TYPE_GROUP, TYPE_HATCH, TYPE_INSERT, TYPE_LAYER, TYPE_LAYER_CONTROL, TYPE_LEADER, TYPE_LINE, TYPE_LTYPE, TYPE_LTYPE_CONTROL, TYPE_LW_POLYLINE, TYPE_MINSERT, TYPE_MLINE, TYPE_MLINESTYLE, TYPE_MTEXT, TYPE_POINT, TYPE_POLYLINE_2D, TYPE_POLYLINE_3D, TYPE_POLYLINE_MESH, TYPE_POLYLINE_PFACE, TYPE_RAY, TYPE_REGION, TYPE_SEQEND, TYPE_SHAPE, TYPE_SOLID, TYPE_SOLID_3D, TYPE_SPLINE, TYPE_STYLE, TYPE_STYLE_CONTROL, TYPE_TEXT, TYPE_TOLERANCE, TYPE_TRACE, TYPE_UCS, TYPE_UCS_CONTROL, TYPE_VERTEX_2D, TYPE_VERTEX_3D, TYPE_VERTEX_MESH, TYPE_VERTEX_PFACE, TYPE_VERTEX_PFACE_FACE, TYPE_VIEW, TYPE_VIEW_CONTROL, TYPE_VIEWPORT, TYPE_VP_ENT_HDR, TYPE_VP_ENT_HDR_CTRL, TYPE_VPORT, TYPE_VPORT_CONTROL, TYPE_XLINE

Constructor Summary

Constructors

Constructor	Description
TLcdDWGBlock(TLcdDWGExtendedEntityData aExtendedEntityData, TLcdDWGDisplayInfo aDisplayInfo)	Creates a new TLcdDWGBlock with the given DWG properties and shape properties as specified for TLcdShapeList.
TLcdDWGBlock(TLcdDWGExtendedEntityData aExtendedEntityData, TLcdDWGDisplayInfo aDisplayInfo, String aName)	Creates a new TLcdDWGBlock with the given DWG properties and shape properties as specified for TLcdShapeList.
TLcdDWGBlock(TLcdDWGExtendedEntityData aExtendedEntityData, TLcdDWGDisplayInfo aDisplayInfo, String aName, ILcdShape[] aShapes)	Creates a new TLcdDWGBlock with the given DWG properties and shape properties as specified for TLcdShapeList.

Method Summary

Modifier and Type	Method	Description
boolean	canSetFeature(int aIndex)	Checks whether the specified feature is editable.
TLcdDataType	getDataType()	Returns the type of this data object.
TLcdDWGDisplayInfo	getDisplayInfo()	Returns the display information of this ILcdDWGShape.
short	getDWGType()	Returns the DWG type of this ILcdDWGShape.
TLcdDWGExtendedEntityData	getExtendedEntityData()	Returns the extended entity data of this ILcdDWGShape, or null if there aren't any.
Object	getFeature(int aIndex)	Returns the feature Object at the given index.
int	getFeatureCount()	Returns the number of features.
String	getName()
Object	getValue(TLcdDataProperty aProperty)	Returns the value of the given property.
Object	getValue(String aPropertyName)	Convenience method that returns the value of the property with the given name.
boolean	hasValue(TLcdDataProperty aProperty)	Indicates whether this data object has a value for the given property.
boolean	hasValue(String aPropertyName)	Indicates whether this data object has a value for the given property.
void	setFeature(int aIndex, Object aFeature)	Sets the feature Object at the given index.
void	setName(String aName)
void	setValue(TLcdDataProperty aProperty, Object aValue)	Sets the value of the given property for this data object.
void	setValue(String aPropertyName, Object aValue)	Convenience method that sets the value of the property with the given name.

Methods inherited from class com.luciad.shape.TLcdShapeList

addShape, addShape, addShapes, clearShapes, clone, getShape, getShapeCount, removeShape, removeShape, removeShapes, setShape, setShape, setShapes, shapeChanged, shapeChanged, shapesChanged

Methods inherited from class com.luciad.shape.ALcdShapeList

calculateFocusPoint, clearCache, contains2D, contains3D, equals, getBounds, getCachedObject, getFocusPoint, hashCode, insertIntoCache, invalidateBounds, invalidateObject, removeCachedObject, setFocusPoint, toString

Methods inherited from class com.luciad.shape.ALcdShape

contains2D, contains3D, fromDomainObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.luciad.shape.ILcdBounded

getBounds

Methods inherited from interface com.luciad.util.ILcdCloneable

clone

Methods inherited from interface com.luciad.shape.ILcdShape

contains2D, contains2D, contains3D, contains3D, getFocusPoint

Constructor Details

TLcdDWGBlock

public TLcdDWGBlock(TLcdDWGExtendedEntityData aExtendedEntityData,
 TLcdDWGDisplayInfo aDisplayInfo)

Creates a new TLcdDWGBlock with the given DWG properties and shape properties as specified for TLcdShapeList.

Parameters:

aExtendedEntityData - the DWG extended entity data.

aDisplayInfo - the DWG display information.

TLcdDWGBlock

public TLcdDWGBlock(TLcdDWGExtendedEntityData aExtendedEntityData,
 TLcdDWGDisplayInfo aDisplayInfo,
 String aName)

Creates a new TLcdDWGBlock with the given DWG properties and shape properties as specified for TLcdShapeList.

Parameters:

aExtendedEntityData - the DWG extended entity data.

aDisplayInfo - the DWG display information.

aName - the block name.

TLcdDWGBlock

public TLcdDWGBlock(TLcdDWGExtendedEntityData aExtendedEntityData,
 TLcdDWGDisplayInfo aDisplayInfo,
 String aName,
 ILcdShape[] aShapes)

Creates a new TLcdDWGBlock with the given DWG properties and shape properties as specified for TLcdShapeList.

Parameters:

aExtendedEntityData - the DWG extended entity data.

aDisplayInfo - the DWG display information.

aName - the block name.

aShapes - the shapes that are part of the block.

Method Details

getFeatureCount

public int getFeatureCount()

Description copied from interface: ILcdFeatured

Returns the number of features.

Specified by:

getFeatureCount in interface ILcdFeatured

Returns:

the number of features.

getFeature

public Object getFeature(int aIndex)
                  throws IndexOutOfBoundsException

Description copied from interface: ILcdFeatured

Returns the feature Object at the given index.

Specified by:

getFeature in interface ILcdFeatured

Parameters:

aIndex - a valid feature index.

Returns:

the feature Object at the given index.

Throws:

IndexOutOfBoundsException - when an index is chosen greater than the result of getFeatureCount.

See Also:

• ILcdFeatured.setFeature(int, java.lang.Object)

setFeature

public void setFeature(int aIndex,
 Object aFeature)
                throws IllegalArgumentException

Description copied from interface: ILcdFeatured

Sets the feature Object at the given index.

Specified by:

setFeature in interface ILcdFeatured

Parameters:

aIndex - a valid feature index.

aFeature - the new feature Object.

Throws:

IllegalArgumentException - if the feature can't be set.

See Also:

• ILcdFeatured.getFeature(int)
• ILcdFeatured.canSetFeature(int)

canSetFeature

public boolean canSetFeature(int aIndex)

Description copied from interface: ILcdFeatured

Checks whether the specified feature is editable.

Specified by:

canSetFeature in interface ILcdFeatured

Parameters:

aIndex - a valid feature index.

Returns:

true if the feature can be set, false otherwise.

getExtendedEntityData

public TLcdDWGExtendedEntityData getExtendedEntityData()

Description copied from interface: ILcdDWGShape

Returns the extended entity data of this ILcdDWGShape, or null if there aren't any.

Specified by:

getExtendedEntityData in interface ILcdDWGShape

Returns:

the extended entity data of this ILcdDWGShape, or null if there aren't any.

getDisplayInfo

public TLcdDWGDisplayInfo getDisplayInfo()

Description copied from interface: ILcdDWGShape

Returns the display information of this ILcdDWGShape.

Specified by:

getDisplayInfo in interface ILcdDWGShape

Returns:

the display information of this ILcdDWGShape.

setName

public void setName(String aName)

getName

public String getName()

getDWGType

public short getDWGType()

Description copied from interface: ILcdDWGShape

Returns the DWG type of this ILcdDWGShape.

Specified by:

getDWGType in interface ILcdDWGShape

Returns:

the DWG type of this ILcdDWGShape.

getValue

public Object getValue(TLcdDataProperty aProperty)

Description copied from interface: ILcdDataObject

Returns the value of the given property.

If the property is a collection, the returned value will never be null. If the property has not been set, an empty collection of the appropriate type will be returned (Set, List or Map).

The property must not be null, and must be declared in the data object's type or in one of its super types. Otherwise an IllegalArgumentException is thrown.

Specified by:

getValue in interface ILcdDataObject

Parameters:

aProperty - the property for which the value is to be returned

Returns:

the value of the given property for this data object

getDataType

public TLcdDataType getDataType()

Description copied from interface: ILcdDataObject

Returns the type of this data object. This can never be null.

Specified by:

getDataType in interface ILcdDataObject

Returns:

the type of this data object

setValue

public void setValue(TLcdDataProperty aProperty,
 Object aValue)

Description copied from interface: ILcdDataObject

Sets the value of the given property for this data object. The implementation is allowed to throw an exception if the given value can't be set.

The given property must be declared in the data object's type or in one of its super types. In other words, getDataType().getProperties().contains( aProperty ) should always be true. Otherwise, the implementation should throw an IllegalArgumentException.

Specified by:

setValue in interface ILcdDataObject

Parameters:

aProperty - the property for which the value is to be set

aValue - the value to set

See Also:

• TLcdDataType.getProperty(String)

getValue

public Object getValue(String aPropertyName)

Description copied from interface: ILcdDataObject

Convenience method that returns the value of the property with the given name.

If more than one property exists with the given name, the most specific property should be used (this is the property defined by the most specialized type in this object's data type hierarchy).

See ILcdDataObject.getValue(TLcdDataProperty) for more information.

Specified by:

getValue in interface ILcdDataObject

Parameters:

aPropertyName - the name of the property of which the value is to be returned

Returns:

the value of the property with the given name

See Also:

• TLcdDataType.getProperty(String)

setValue

public void setValue(String aPropertyName,
 Object aValue)

Description copied from interface: ILcdDataObject

Convenience method that sets the value of the property with the given name.

If more than one property exists with the given name, the most specific property should be used (this is the property defined by the most specialized type in this object's data type hierarchy).

See ILcdDataObject.setValue(TLcdDataProperty, Object) for more information.

Specified by:

setValue in interface ILcdDataObject

Parameters:

aPropertyName - the name of the property of which the value is to be set

aValue - the value to set

hasValue

public boolean hasValue(TLcdDataProperty aProperty)

Description copied from interface: ILcdDataObject

Indicates whether this data object has a value for the given property.

• aProperty is from the right data type, and this instance has a value for it: returns true
• aProperty is from the right data type, and this instance has no value for it: returns false
• aProperty is not from the right data type: not allowed, you will get IllegalArgumentException
• aProperty is null: not allowed, you will get NullPointerException

A multivalued property is considered to have a value if it has at least one value.

Specified by:

hasValue in interface ILcdDataObject

Parameters:

aProperty - the property for which to return whether a value is present or not.

Returns:

true if this data object has a value for the given property, false otherwise.

hasValue

public boolean hasValue(String aPropertyName)

Description copied from interface: ILcdDataObject

Indicates whether this data object has a value for the given property.
See ILcdDataObject.hasValue(TLcdDataProperty) for more information.

Specified by:

hasValue in interface ILcdDataObject

Parameters:

aPropertyName - the name of the property for which to return whether a value is present or not.

Returns:

true if this data object has a value for the property with the given name, false otherwise.