com.esri.sde.sdk.client
Class SeRegistration

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

All Implemented Interfaces:

java.lang.Cloneable

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

Field Summary

static int	SE_REGISTRATION_ROW_ID_ALLOCATION_MANY
static int	SE_REGISTRATION_ROW_ID_ALLOCATION_SINGLE
static int	SE_REGISTRATION_ROW_ID_COLUMN_TYPE_NONE
static int	SE_REGISTRATION_ROW_ID_COLUMN_TYPE_SDE
static int	SE_REGISTRATION_ROW_ID_COLUMN_TYPE_USER

Constructor Summary

SeRegistration(SeConnection conn)
SeRegistration constructor with an SeConnection.Use this constructor when registrating a new object.

SeRegistration(SeConnection conn, SeObjectId regId)
SeRegistration constructor with an SeConnection and table registration Id that retrives the registration entry information for specified ID.

SeRegistration(SeConnection conn, java.lang.String tableName)
SeRegistration constructor with an SeConnection and table name that retrives the registration entry information for specified table.

Method Summary

boolean	allowRowlocks() Returns TRUE if rowlocking is enabled.
void	alter() Alters the properties of a registered table.
java.lang.Object	clone() Clones the SeRegistration object.
void	create() Register an existing table with ArcSde.
void	delete() Unregisters a table.
int	getAccess() Returns the privilege bitmask for a registered table.The privileges are: SeDefs.SE_SELECT_PRIVILEGE SeDefs.SE_UPDATE_PRIVILEGE SeDefs.SE_INSERT_PRIVILEGE SeDefs.SE_DELETE_PRIVILEGE
java.lang.String	getCreationKeyword() Returns the configuration keyword used for table creation.
java.lang.String[]	getDependentTables() Returns a dynamically allocated list of all dependent tables for a given table.
java.lang.String	getDescription() Returns the registered table's description.
SeRegistration[]	getDifferenceList(SeObjectId state1Id, SeObjectId state2Id) Returns a list SeRegistration objects for all of the multiversion tables that are modified in either of the input states or any of the states joining them in the state tree (excluding their shared parent), and for which the current user has any access to the DBMS tables.
SeObjectId	getId() Returns the ID of a registered table.
void	getInfo() Returns registration information.
SeObjectId	getMinimumId() Returns the the minimum ID allowed in the registered table.
java.lang.String	getMvViewName() Returns the multiversion view name of a registered table.
java.util.Date	getRegistrationDate() Returns the registration date of a table.
int	getRowIdAllocation() Returns the method used by this registered table to allocate SDE-maintained rowids.
java.lang.String	getRowIdColumnName() Returns the row ID column name for a registered table.
int	getRowIdColumnType() Returns the row ID column type for a registered table.
java.lang.String	getTableName() Returns the table name for a registered table.
boolean	hasLayer() Returns TRUE if the registered table has a spatial column.
boolean	hasXml() Returns TRUE if this table have an xml column.
boolean	isBaseSave() A base-save table is a multiversioned table whose changes can be saved into the base state or saved to the base table directly.
boolean	isHidden() Returns TRUE if the registered table is hidden.
boolean	isMultiVersion() Returns TRUE if the registered is a multiversioned table.
boolean	isView() Returns TRUE if the registered table is a view.
void	setBaseSave(boolean isBaseSave) Sets the base-save flag for a registered table.
void	setCreationKeyword(java.lang.String creationKeyword) Sets the configuration keyword used for table creation.
void	setDescription(java.lang.String desc) Sets the registered table's description.
void	setHidden(boolean hidden) Sets the hidden flag for a registered table.
void	setMinimumId(SeObjectId minId) Sets the minimum ID allowed for the registered table.
void	setMultiVersion(boolean isMultiVersion) Sets the multiversion flag for a registered table.
void	setRowIdAllocation(int method) Sets a registration entry's method of allocating ArcSDE-maintained rows ids.
void	setRowIdColumnName(java.lang.String rowidColumn) Sets the row ID column name for a registered table.
void	setRowIdColumnType(int rowidColumnType) Sets the row ID column name for a registered table.
void	setRowlocks(boolean allowRowlocks) Sets row locking to enabled or dis abled on a registered table.
void	setTableName(java.lang.String tableName) Sets the table name for a registered table.
void	setView(boolean isView) Sets the view flag for a registered table.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SE_REGISTRATION_ROW_ID_COLUMN_TYPE_SDE

public static final int SE_REGISTRATION_ROW_ID_COLUMN_TYPE_SDE

See Also:

Constant Field Values

SE_REGISTRATION_ROW_ID_COLUMN_TYPE_USER

public static final int SE_REGISTRATION_ROW_ID_COLUMN_TYPE_USER

See Also:

Constant Field Values

SE_REGISTRATION_ROW_ID_COLUMN_TYPE_NONE

public static final int SE_REGISTRATION_ROW_ID_COLUMN_TYPE_NONE

See Also:

Constant Field Values

SE_REGISTRATION_ROW_ID_ALLOCATION_SINGLE

public static final int SE_REGISTRATION_ROW_ID_ALLOCATION_SINGLE

See Also:

Constant Field Values

SE_REGISTRATION_ROW_ID_ALLOCATION_MANY

public static final int SE_REGISTRATION_ROW_ID_ALLOCATION_MANY

See Also:

Constant Field Values

Constructor Detail

SeRegistration

public SeRegistration(SeConnection conn)
               throws SeException

SeRegistration constructor with an SeConnection.Use this constructor when registrating a new object. You must set call setTableName() when using this constructor.

Parameters:

conn - SeConnection object handle.

Throws:

SeException

SeRegistration

public SeRegistration(SeConnection conn,
                      SeObjectId regId)
               throws SeException

SeRegistration constructor with an SeConnection and table registration Id that retrives the registration entry information for specified ID.

Parameters:

conn - SeConnection object handle.

regId - the registration table ID.

Throws:

SeException

SeRegistration

public SeRegistration(SeConnection conn,
                      java.lang.String tableName)
               throws SeException

SeRegistration constructor with an SeConnection and table name that retrives the registration entry information for specified table.

Parameters:

conn - SeConnection object handle.

tableName - table name.

Throws:

SeException

Method Detail

alter

public void alter()
           throws SeException

Alters the properties of a registered table. You can change the registration entry's description, minimum_id, and row_id column type. However, only integer columns can be made ArcSDE-maintained. A registration entry for an multiversion table may not have a row_id column type of SE_REGISTRATION_ROW_ID_COLUMN_TYPE_NONE. Only the owner of the table may alter its properties.

Throws:

SeException

create

public void create()
            throws SeException

Register an existing table with ArcSde. The table must be owned by the current user and the user-maintained rowid should be present if specified.

Throws:

SeException

delete

public void delete()
            throws SeException

Unregisters a table. Only the owner of the table may delete the registered table entry. Tables with mangos, multiversion tables, or layers can't be unregistered.

Throws:

SeException

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Clones the SeRegistration object.

Overrides:

clone in class java.lang.Object

Returns:

a SeRegistration as type Object.

Throws:

java.lang.CloneNotSupportedException - if an error occurs

getDifferenceList

public SeRegistration[] getDifferenceList(SeObjectId state1Id,
                                          SeObjectId state2Id)
                                   throws SeException

Returns a list SeRegistration objects for all of the multiversion tables that are modified in either of the input states or any of the states joining them in the state tree (excluding their shared parent), and for which the current user has any access to the DBMS tables. This can be used to help implement manual difference resolution. The two states may also be the same, in which case only those tables modified in that particular state are returned.

Parameters:

state1Id - the ID of the first state.

state2Id - the ID of the second state.

Returns:

SeRegistration[]

Throws:

SeException

getInfo

public void getInfo()
             throws SeException

Returns registration information.

Throws:

SeException

getDependentTables

public java.lang.String[] getDependentTables()
                                      throws SeException

Returns a dynamically allocated list of all dependent tables for a given table. The returned list contains layer releated table names like feature,index etc. and multi-version table names like adds, deletes, equivalence etc.

Returns:

String[]

Throws:

SeException

getAccess

public int getAccess()

Returns the privilege bitmask for a registered table.The privileges are: SeDefs.SE_SELECT_PRIVILEGE SeDefs.SE_UPDATE_PRIVILEGE SeDefs.SE_INSERT_PRIVILEGE SeDefs.SE_DELETE_PRIVILEGE

Returns:

int

getCreationKeyword

public java.lang.String getCreationKeyword()

Returns the configuration keyword used for table creation.

Returns:

String

setCreationKeyword

public void setCreationKeyword(java.lang.String creationKeyword)

Sets the configuration keyword used for table creation.

getDescription

public java.lang.String getDescription()

Returns the registered table's description.

Returns:

String

setDescription

public void setDescription(java.lang.String desc)

Sets the registered table's description.

getId

public SeObjectId getId()

Returns the ID of a registered table.

Returns:

SeObjectId

getMvViewName

public java.lang.String getMvViewName()

Returns the multiversion view name of a registered table.

Returns:

String

getMinimumId

public SeObjectId getMinimumId()

Returns the the minimum ID allowed in the registered table. If an ArcSDE-maintained row ID column doesn't exist, the function returns zero.

Returns:

SeObjectId

setMinimumId

public void setMinimumId(SeObjectId minId)
                  throws SeException

Sets the minimum ID allowed for the registered table.

Throws:

SeException

getRegistrationDate

public java.util.Date getRegistrationDate()

Returns the registration date of a table.

Returns:

java.util.Date

getRowIdColumnName

public java.lang.String getRowIdColumnName()

Returns the row ID column name for a registered table. If no row ID column exists null value is returned.

Returns:

String

setRowIdColumnName

public void setRowIdColumnName(java.lang.String rowidColumn)
                        throws SeException

Sets the row ID column name for a registered table.

Throws:

SeException

getRowIdAllocation

public int getRowIdAllocation()

Returns the method used by this registered table to allocate SDE-maintained rowids.

Returns:

int

setRowIdAllocation

public void setRowIdAllocation(int method)
                        throws SeException

Sets a registration entry's method of allocating ArcSDE-maintained rows ids.

Parameters:

method - SE_REGISTRATION_ROW_ID_ALLOCATION_SINGLE or SE_REGISTRATION_ROW_ID_ALLOCATION_MANY

Throws:

SeException

getRowIdColumnType

public int getRowIdColumnType()

Returns the row ID column type for a registered table. If no row ID column exists, 0 will be returned. The column type are: SE_REGISTRATION_ROW_ID_COLUMN_TYPE_SDE SE_REGISTRATION_ROW_ID_COLUMN_TYPE_USER SE_REGISTRATION_ROW_ID_COLUMN_TYPE_NONE

Returns:

int

setRowIdColumnType

public void setRowIdColumnType(int rowidColumnType)
                        throws SeException

Sets the row ID column name for a registered table.

Throws:

SeException

getTableName

public java.lang.String getTableName()

Returns the table name for a registered table.

Returns:

String

setTableName

public void setTableName(java.lang.String tableName)
                  throws SeException

Sets the table name for a registered table.

Throws:

SeException

hasLayer

public boolean hasLayer()

Returns TRUE if the registered table has a spatial column.

Returns:

boolean

isHidden

public boolean isHidden()

Returns TRUE if the registered table is hidden.

Returns:

boolean

isBaseSave

public boolean isBaseSave()

A base-save table is a multiversioned table whose changes can be saved into the base state or saved to the base table directly. This function returns TRUE if the registered table object is base-save, and FALSE if it does not. If the SE_REGINFO object is somehow invalid, then FALSE is also returned.

Returns:

boolean

setBaseSave

public void setBaseSave(boolean isBaseSave)

Sets the base-save flag for a registered table.

setHidden

public void setHidden(boolean hidden)

Sets the hidden flag for a registered table.

isView

public boolean isView()

Returns TRUE if the registered table is a view.

Returns:

boolean

setView

public void setView(boolean isView)

Sets the view flag for a registered table.

hasXml

public boolean hasXml()

Returns TRUE if this table have an xml column.

Returns:

boolean

isMultiVersion

public boolean isMultiVersion()

Returns TRUE if the registered is a multiversioned table.

Returns:

boolean

setMultiVersion

public void setMultiVersion(boolean isMultiVersion)

Sets the multiversion flag for a registered table.

allowRowlocks

public boolean allowRowlocks()

Returns TRUE if rowlocking is enabled.

Returns:

boolean

setRowlocks

public void setRowlocks(boolean allowRowlocks)

Sets row locking to enabled or dis abled on a registered table.