com.esri.arcgis.carto
Class BarrierCollection

java.lang.Object
  com.esri.arcgis.carto.BarrierCollection

All Implemented Interfaces:

IBarrierCollection, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class BarrierCollection
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IBarrierCollection

A collection of objects that act as barriers to label placement.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

BarrierCollection()
Constructs a BarrierCollection using ArcGIS Engine.

BarrierCollection(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
BarrierCollection theBarrierCollection = (BarrierCollection) obj;

Method Summary

void	add(IGeometryCollection barriers, int weight) Adds the specified item to the collection.
void	clear() Removes all the items in the collection.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
int	getCount() The number of items in the collection.
int	hashCode() the hashcode for this object
void	queryItem(int index, IGeometryCollection[] barrier, int[] weight) Returns the item in the collection at the specified index.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

BarrierCollection

public BarrierCollection()
                  throws IOException,
                         UnknownHostException

Constructs a BarrierCollection using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

BarrierCollection

public BarrierCollection(Object obj)
                  throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
BarrierCollection theBarrierCollection = (BarrierCollection) obj;

Construct a BarrierCollection using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to BarrierCollection.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

add

public void add(IGeometryCollection barriers,
                int weight)
         throws IOException,
                AutomationException

Adds the specified item to the collection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

add in interface IBarrierCollection

Parameters:

barriers - A reference to a com.esri.arcgis.geometry.IGeometryCollection (in)

weight - A com.esri.arcgis.carto.esriBasicOverposterWeight constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws IOException,
                    AutomationException

The number of items in the collection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCount in interface IBarrierCollection

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryItem

public void queryItem(int index,
                      IGeometryCollection[] barrier,
                      int[] weight)
               throws IOException,
                      AutomationException

Returns the item in the collection at the specified index.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

queryItem in interface IBarrierCollection

Parameters:

index - The index (in)

barrier - A reference to a com.esri.arcgis.geometry.IGeometryCollection (out: use single element array)

weight - A com.esri.arcgis.carto.esriBasicOverposterWeight constant (out: use single element array, optional, pass single element of null if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clear

public void clear()
           throws IOException,
                  AutomationException

Removes all the items in the collection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

clear in interface IBarrierCollection

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.