SeLayer (ArcSDE Java API Documentation v10.0)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.sde.sdk.client
Class SeLayer

java.lang.Object
  com.esri.sde.sdk.client.SeLayer

All Implemented Interfaces:: java.lang.Cloneable

public class SeLayer
extends java.lang.Object
implements java.lang.Cloneable
extends java.lang.Object
implements java.lang.Cloneable

SeLayer - An object that spatially enables an existing RDBMS table. The term spatially enable means adding spatial information to any RDBMS table. It designates a column as the spatial column. If the the spatial column does not exist, ArcSDE will add it. If it does exist, all rows must have a NULL value and the column must be of integer type. It also builds a spatial index and other tables that ArcSDE requires to store spatial information. Spatial information includes the type of spatial feature such as area or line, projection information, false origins, units of measure, and geographic extent.

Nested Class Summary
`static class`	`SeLayer.SeLayerGridStats` SeLayer inner class that retrieves the spatial index grid statistics.
`static class`	`SeLayer.SeLayerLock` SeLayer inner class that retrieves the layer lock information from the ArcSDE server.
`static class`	`SeLayer.SeLayerSpatialIndexStats` SeLayer inner class that retrieves the spatial index statistics for a layer.
`static class`	`SeLayer.SeLayerStats` SeLayer inner class that obtains the statistics for a layer.

Field Summary
`static int`	`GSIZE_MULT` The grid size multiple; when creating a layer with grid indexes, each successive grid size must be greater than the product of the previous grid size and this multiple.
`static int`	`SE_AREA_TYPE_MASK` One of the allowable shape types for a layer, representing area or polygon shapes.
`static int`	`SE_LAYER_AUTO_REGISTER`
`static int`	`SE_LAYER_HAS_GEODETIC_EXTENT`
`static int`	`SE_LAYER_HAS_USER_DEFINED_EXTENT`
`static int`	`SE_LAYER_PRECISION_32_BIT` Deprecated. at ArcSDE v9.2, replaced by `SE_LAYER_PRECISION_BASIC`
`static int`	`SE_LAYER_PRECISION_64_BIT` Deprecated. at ArcSDE v9.2, replaced by `SE_LAYER_PRECISION_HIGH`
`static int`	`SE_LAYER_PRECISION_BASIC`
`static int`	`SE_LAYER_PRECISION_DEFAULT`
`static int`	`SE_LAYER_PRECISION_HIGH`
`static int`	`SE_LINE_TYPE_MASK` One of the allowable shape types for a layer, representing line shapes.
`static int`	`SE_MIN_GRIDSIZE` This constant defines the minimum grid size value allowed when creating the grid indexes for a layer.
`static int`	`SE_MULTIPART_TYPE_MASK` One of the allowable shape types for a layer, representing multi-part shapes.
`static int`	`SE_NIL_TYPE_MASK` One of the allowable shape types for a layer, representing nil shapes.
`static int`	`SE_POINT_TYPE_MASK` One of the allowable shape types for a layer, representing point shapes.
`static int`	`SE_READ_LOCK` One of the allowable locks on a layer.
`static int`	`SE_SHAPE_ATTRIBUTE_AREA` Represents the area attribute of a shape.
`static int`	`SE_SHAPE_ATTRIBUTE_ENTITY` Represents the entity attribute of a shape.
`static int`	`SE_SHAPE_ATTRIBUTE_FID` Represents the feature id attribute of a shape.
`static int`	`SE_SHAPE_ATTRIBUTE_LENGTH` Represents the length attribute of a shape.
`static int`	`SE_SHAPE_ATTRIBUTE_MMAX` Represents the maximum measure attribute of a shape.
`static int`	`SE_SHAPE_ATTRIBUTE_MMIN` Represents the minimum measure attribute of a shape.
`static int`	`SE_SHAPE_ATTRIBUTE_NUMOFPTS` Represents the number of points attribute of a shape.
`static int`	`SE_SHAPE_ATTRIBUTE_TEXT` Represents the text attribute of a shape.
`static int`	`SE_SHAPE_ATTRIBUTE_XMAX` Represents the maximum x attribute of a shape.
`static int`	`SE_SHAPE_ATTRIBUTE_XMIN` Represents the minimum x value attribute of a shape.
`static int`	`SE_SHAPE_ATTRIBUTE_YMAX` Represents the maximum y attribute of a shape.
`static int`	`SE_SHAPE_ATTRIBUTE_YMIN` Represents the minimum y attribute of a shape.
`static int`	`SE_SHAPE_ATTRIBUTE_ZMAX` Represents the maximum z attribute of a shape.
`static int`	`SE_SHAPE_ATTRIBUTE_ZMIN` Represents the minimum z attribute of a shape.
`static int`	`SE_SIMPLE_LINE_TYPE_MASK` One of the allowable shape types for a layer, representing simple line shapes.
`static int`	`SE_SPATIALINDEX_DBTUNE` One of the allowable spatial index types.
`static int`	`SE_SPATIALINDEX_FIXED_QUADTREE` One of the allowable spatial index types.
`static int`	`SE_SPATIALINDEX_HYBRID_QUADTREE` One of the allowable spatial index types.
`static int`	`SE_SPATIALINDEX_MULTI_GRID` One of the allowable spatial index types.
`static int`	`SE_SPATIALINDEX_NONE` One of the allowable spatial index types.
`static int`	`SE_SPATIALINDEX_RTREE` One of the allowable spatial index types.
`static int`	`SE_SPATIALINDEX_SQL_SERVER`
`static int`	`SE_SPATIALINDEX_UNKNOWN`
`static int`	`SE_STORAGE_LOB_TYPE`
`static int`	`SE_STORAGE_NORMALIZED_TYPE`
`static int`	`SE_STORAGE_SDEBINARY_TYPE`
`static int`	`SE_STORAGE_SPATIAL_TYPE`
`static int`	`SE_STORAGE_SQL_TYPE`
`static int`	`SE_STORAGE_WKB_TYPE`
`static int`	`SE_WRITE_LOCK` One of the allowable locks on a layer.
`static int`	`TYPE_LINE`
`static int`	`TYPE_MULTI_LINE`
`static int`	`TYPE_MULTI_MASK`
`static int`	`TYPE_MULTI_POINT`
`static int`	`TYPE_MULTI_POLYGON`
`static int`	`TYPE_MULTI_SIMPLE_LINE`
`static int`	`TYPE_NIL`
`static int`	`TYPE_POINT`
`static int`	`TYPE_POLYGON`
`static int`	`TYPE_SIMPLE_LINE`

Constructor Summary
`SeLayer(SeConnection conn)` This constructor is used to create a new ArcSDE layer.
`SeLayer(SeConnection conn, SeObjectId layerId)` This SeLayer constructor is used to retrieve the properties of a layer from an ArcSDE server.
`SeLayer(SeConnection conn, java.lang.String table, java.lang.String spatCol)` This SeLayer constructor is used to retrieve the properties of a layer from an ArcSDE server.

Method Summary
`void`	`alter()` Alters modifiable characteristics of a layer after creation.
`SeExtent`	`calculateExtent(boolean useIndex, SeSqlConstruct sqlC)` Calculates the extent (the minimum bounding box) of the features in a layer.
`java.lang.Object`	`clone()` Clones this `SeLayer` object.
`void`	`create(int initialFeatures, int avgPoints)` Spatially enables an RDBMS table.
`void`	`delete()` Deletes the spatial components from a spatially enabled table.
`void`	`freeLock()` Frees the lock on an ArcSde layer.
`int`	`getAccess()` Retrieves the privilege bitmask for a layer.
`int`	`getArraySize()` Retrieves the optimal array size for the specified layer.
`SeCoordinateReference`	`getCoordRef()` Retrieves the coordinate reference for the specified layer.
`java.util.Date`	`getCreationDate()` Retrieves the layer creation date.
`int`	`getCreationDateInMillis()` Retrieves the layer creation date.
`java.lang.String`	`getCreationKeyword()` Retrieves the configuration keyword.
`java.lang.String`	`getDescription()` Retrieves the layer's description.
`SeExtent`	`getExtent()` Retrieves the layer's envelope.
`double[]`	`getGridSizes()` Returns an array of layer's grid sizes.
`SeObjectId`	`getID()` Retrieves the layer ID.
`void`	`getInfo()` Refreshes the properties of this SeLayer object by reading them from the ArcSDE server.
`SeLayer.SeLayerLock[]`	`getLocks()` Returns a list of current locks.
`double`	`getMaxM()` Returns the maximum measure value.
`double`	`getMaxZ()` Returns the maximum elevation value.
`SeObjectId`	`getMinID()` Retrieves the minimum FID id.
`double`	`getMinM()` Returns the minimum measure value.
`double`	`getMinZ()` Returns the minimum elevation value.
`java.lang.String`	`getName()` Returns the name of the table associated with the layer.
`java.lang.String`	`getQualifiedName()` Returns the layer's table name, qualified with the owner.
`java.lang.String`	`getShapeAttributeName(int attrCode)` Returns the column name for a specified shape attribute.
`int`	`getShapeTypes()` Retrieves the allowed shape types.
`java.lang.String`	`getSpatialColumn()` Retrieves the spatial column name of a layer.
`SeLayer.SeLayerSpatialIndexStats`	`getSpatialIndexStats()` Returns statistical information about a layer's spatial indexes.
`int`	`getStatsDate()` Retrieves the stats date for the specified layer.
`java.lang.String`	`getTableName()` Returns the name of the table associated with the layer.
`void`	`grantAccess(int privilege, boolean grant, java.lang.String user)` Grants specified privileges to the specified user.
`boolean`	`hasAnno()` Returns TRUE if a layer has annotation.
`boolean`	`hasCAD()` Returns TRUE if the layer allows CAD.
`boolean`	`hasSparseGrids()` This routine returns true if the layer object is configured so that sparse grid indexes are generated for this layer.
`boolean`	`hasSpatialIndex()` Returns TRUE if the layer has spatial index.
`boolean`	`is3D()` Returns TRUE if the layer allows z-coordinates.
`boolean`	`isLine()` Returns TRUE if the layer has line shapes.
`boolean`	`isLoadOnly()` Returns TRUE if the layer is in load-only mode.
`boolean`	`isMeasured()` Returns TRUE if the layer allows measures.
`boolean`	`isMultiPart()` Returns TRUE if the layer has multipart enabled.
`boolean`	`isPoint()` Returns TRUE if the layer has point shapes.
`boolean`	`isPoly()` Returns TRUE if the layer has polygon shapes.
`boolean`	`isStorageExternal()` Returns TRUE if the layers storage type is external.
`boolean`	`isStorageLOB()` Returns TRUE if the layer's storage type is LOB type.
`boolean`	`isStorageNormalized()` Returns TRUE if the layer's storage type is normalized.
`boolean`	`isStorageSdeBinary()` Returns TRUE if the layer's storage type is sdebinary.
`boolean`	`isStorageSpatial()` Returns TRUE if the layer's storage type is spatial type.
`boolean`	`isStorageSQL()` Returns TRUE if the layer's storage type is SQL or well-known text.
`boolean`	`isStorageWKB()` Returns TRUE if the layer's storage type is well-known binary.
`void`	`lock(int lockMode)` Locks an ArcSde layer.
`void`	`lockArea(int lockMode, SeExtent envelope)` Locks the specified area within ArcSde layer.
`void`	`migrateStorage(java.lang.String config_keyword)` Migrates a layer's geometry storage type from one type of storage to another based on the configuration keyword specified.
`void`	`modifyLock(int lockMode, SeExtent envelope)` Modifies an existing lock on an area or the entire layer.
`void`	`revokeAccess(int privilege, java.lang.String user)` Revokes specified privileges from the specified user.
`void`	`set3D(boolean is3D)` Updates whether the layer allows z-coordinates.
`void`	`setAnno(boolean hasAnno)` Sets whether the layer allows anno.
`void`	`setArraySize(int optArraySize)` Sets the optimal array size for the layer.
`void`	`setCAD(boolean hasCAD)` Sets whether the layer allows CAD entities.
`void`	`setCoordRef(SeCoordinateReference coordref)` Sets the coordinate reference for the specified layer.
`void`	`setCreationKeyword(java.lang.String configKeyword)` Sets the configuration keyword.
`void`	`setDescription(java.lang.String description)` Sets the layer's description.
`void`	`setExtent(SeExtent envelope)` Sets the layer's envelope.
`void`	`setGridSizes(double grid1, double grid2, double grid3)` Sets the spatial index grid sizes of the layer.
`void`	`setLoadMode(boolean isLoadOnly)` Sets the layer to either load-only or normal I/O mode.
`void`	`setMeasured(boolean isMeasured)` Updates whether the layer allows measures.
`void`	`setMinID(SeObjectId minID)` Sets the minimum fid value.
`void`	`setMRange(double minM, double maxM)` Sets the M (measurement) range for this Layer.
`void`	`setSecondaryCoordRef(SeCoordinateReference coordref)` Sets the coordinate reference for the specified layer.
`void`	`setShapeTypes(int shapeTypes)` Sets shape types.
`void`	`setSparseGrids(boolean sparseGrids)` This routine configures the LAYERINFO object to allow or disallow the generation of sparse spatial index grids.
`void`	`setSpatialColumnName(java.lang.String spatialColName)` Sets the spatial column name of the layer.
`void`	`setStorageTypes(int storageTypes)` Sets storage types.
`void`	`setTableName(java.lang.String tableName)` Sets the business table containaing spatial column.
`void`	`setZRange(double minZ, double maxZ)` Sets the Z (elevation) range for this Layer.
`void`	`truncate()` Deletes the shapes of a spatially enabled table's spatial column.

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

TYPE_NIL

public static final int TYPE_NIL

See Also:: Constant Field Values

TYPE_POINT

public static final int TYPE_POINT

See Also:: Constant Field Values

TYPE_LINE

public static final int TYPE_LINE

See Also:: Constant Field Values

TYPE_SIMPLE_LINE

public static final int TYPE_SIMPLE_LINE

See Also:: Constant Field Values

TYPE_POLYGON

public static final int TYPE_POLYGON

See Also:: Constant Field Values

TYPE_MULTI_MASK

public static final int TYPE_MULTI_MASK

See Also:: Constant Field Values

TYPE_MULTI_POINT

public static final int TYPE_MULTI_POINT

See Also:: Constant Field Values

TYPE_MULTI_LINE

public static final int TYPE_MULTI_LINE

See Also:: Constant Field Values

TYPE_MULTI_SIMPLE_LINE

public static final int TYPE_MULTI_SIMPLE_LINE

See Also:: Constant Field Values

TYPE_MULTI_POLYGON

public static final int TYPE_MULTI_POLYGON

See Also:: Constant Field Values

SE_NIL_TYPE_MASK

public static final int SE_NIL_TYPE_MASK

One of the allowable shape types for a layer, representing nil shapes.

See Also:: Constant Field Values

SE_POINT_TYPE_MASK

public static final int SE_POINT_TYPE_MASK

One of the allowable shape types for a layer, representing point shapes.

See Also:: Constant Field Values

SE_LINE_TYPE_MASK

public static final int SE_LINE_TYPE_MASK

One of the allowable shape types for a layer, representing line shapes.

See Also:: Constant Field Values

SE_SIMPLE_LINE_TYPE_MASK

public static final int SE_SIMPLE_LINE_TYPE_MASK

One of the allowable shape types for a layer, representing simple line shapes.

See Also:: Constant Field Values

SE_AREA_TYPE_MASK

public static final int SE_AREA_TYPE_MASK

One of the allowable shape types for a layer, representing area or polygon shapes.

See Also:: Constant Field Values

SE_MULTIPART_TYPE_MASK

public static final int SE_MULTIPART_TYPE_MASK

One of the allowable shape types for a layer, representing multi-part shapes.

See Also:: Constant Field Values

SE_STORAGE_NORMALIZED_TYPE

public static final int SE_STORAGE_NORMALIZED_TYPE

See Also:: Constant Field Values

SE_STORAGE_SDEBINARY_TYPE

public static final int SE_STORAGE_SDEBINARY_TYPE

See Also:: Constant Field Values

SE_STORAGE_WKB_TYPE

public static final int SE_STORAGE_WKB_TYPE

See Also:: Constant Field Values

SE_STORAGE_SQL_TYPE

public static final int SE_STORAGE_SQL_TYPE

See Also:: Constant Field Values

SE_STORAGE_SPATIAL_TYPE

public static final int SE_STORAGE_SPATIAL_TYPE

See Also:: Constant Field Values

SE_STORAGE_LOB_TYPE

public static final int SE_STORAGE_LOB_TYPE

See Also:: Constant Field Values

SE_WRITE_LOCK

public static final int SE_WRITE_LOCK

One of the allowable locks on a layer. SE_WRITE_LOCK allows only the caller to modify the data. The layer can still be read by all other users. Only one SE_WRITE_LOCK lock at a time may exist on a layer.

See Also:: Constant Field Values

SE_READ_LOCK

public static final int SE_READ_LOCK

One of the allowable locks on a layer. SE_READ_LOCK locks the layer against modifications. Multiple SE_READ_LOCK locks can be set on the same layer.

See Also:: Constant Field Values