com.esri.sde.sdk.client
Class SeXmlSchema

java.lang.Object
  extended by com.esri.sde.sdk.client.SeXmlSchema

public class SeXmlSchema
extends java.lang.Object

This class represents an Xml Schema.

Since:
ArcSDE 10.0

Field Summary
static int SE_XML_SCHEMA_CREATE_DEFAULT
           
static int SE_XML_SCHEMA_DB2_CREATE_DISABLE_DECOMPOSITION
           
static int SE_XML_SCHEMA_DB2_CREATE_ENABLE_DECOMPOSITION
           
static int SE_XML_SCHEMA_DB2_STATUS_COMPLETE
           
static int SE_XML_SCHEMA_DB2_STATUS_INCOMPLETE
           
static int SE_XML_SCHEMA_DB2_STATUS_REPLACE
           
static int SE_XML_SCHEMA_DB2_STATUS_TEMPORARY
           
static int SE_XML_SCHEMA_DB2_UPDATE_DROP_NEW
           
static int SE_XML_SCHEMA_DB2_UPDATE_PRESERVE_NEW
           
static int SE_XML_SCHEMA_DELETE_DEFAULT
           
static int SE_XML_SCHEMA_ORA_CREATE_BINARYXML
           
static int SE_XML_SCHEMA_ORA_CREATE_NODOCID
           
static int SE_XML_SCHEMA_ORA_CREATE_NT_AS_IOT
           
static int SE_XML_SCHEMA_ORA_DELETE_CASCADE
           
static int SE_XML_SCHEMA_ORA_DELETE_CASCADE_FORCE
           
static int SE_XML_SCHEMA_ORA_DELETE_INVALIDATE
           
static int SE_XML_SCHEMA_ORA_DELETE_RESTRICT
           
static int SE_XML_SCHEMA_ORA_STATUS_BINARY
           
static int SE_XML_SCHEMA_ORA_STATUS_HIDDEN
           
static int SE_XML_SCHEMA_ORA_STATUS_HIERARCHY_TYPE_CONTENTS
           
static int SE_XML_SCHEMA_ORA_STATUS_HIERARCHY_TYPE_NONE
           
static int SE_XML_SCHEMA_ORA_STATUS_HIERARCHY_TYPE_RESMETADATA
           
static int SE_XML_SCHEMA_ORA_STATUS_LOCAL
           
static int SE_XML_SCHEMA_ORA_UPDATE_BINARY_XML
           
static int SE_XML_SCHEMA_UPDATE_DEFAULT
           
 
Constructor Summary
SeXmlSchema(SeConnection conn)
          This constructor creates a new SeXmlSchema object and is used to add an XML Schema.
SeXmlSchema(SeConnection conn, java.lang.String schemaName)
          This constructor retrieves information of an existing XML schema
 
Method Summary
 void create()
          This method creates an XML schema.
 void delete(int delete_options)
          This method deletes an XML schema.The schema name is SQL schema qualified.
 int getRegistrationFlag()
          Get the registration flag of the xml schema object.
 SeXmlSchemaCollection getXmlSchemaCollection()
          get Xml schema Collection of the Xml Schema.
 java.lang.String getXmlSchemaName()
          Get the name of the xml schema .
 java.lang.String getXmlSchemaPropertyText()
          Gets the XML schema's property.
 void setRegistrationFlag(int flag)
          Set the registration flag of the xml schema object.
 void setXmlSchemaCollection(SeXmlSchemaCollection xmlCollection)
          Set xml schema collectin for the Xml Schema object.
 void setXmlSchemaName(java.lang.String name)
          Set the name of the xml schema .
 void setXmlSchemaPropertyText(java.lang.String text)
          Sets the XML schema's property.
 void update(SeXmlSchema new_xmlschema, SeXmlSchema style_sheet, int update_options)
          This method update an existing XML schema.This function updates xml schema object.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SE_XML_SCHEMA_CREATE_DEFAULT

public static final int SE_XML_SCHEMA_CREATE_DEFAULT
See Also:
Constant Field Values

SE_XML_SCHEMA_DB2_CREATE_DISABLE_DECOMPOSITION

public static final int SE_XML_SCHEMA_DB2_CREATE_DISABLE_DECOMPOSITION
See Also:
Constant Field Values

SE_XML_SCHEMA_DB2_CREATE_ENABLE_DECOMPOSITION

public static final int SE_XML_SCHEMA_DB2_CREATE_ENABLE_DECOMPOSITION
See Also:
Constant Field Values

SE_XML_SCHEMA_ORA_CREATE_NODOCID

public static final int SE_XML_SCHEMA_ORA_CREATE_NODOCID
See Also:
Constant Field Values

SE_XML_SCHEMA_ORA_CREATE_BINARYXML

public static final int SE_XML_SCHEMA_ORA_CREATE_BINARYXML
See Also:
Constant Field Values

SE_XML_SCHEMA_ORA_CREATE_NT_AS_IOT

public static final int SE_XML_SCHEMA_ORA_CREATE_NT_AS_IOT
See Also:
Constant Field Values

SE_XML_SCHEMA_UPDATE_DEFAULT

public static final int SE_XML_SCHEMA_UPDATE_DEFAULT
See Also:
Constant Field Values

SE_XML_SCHEMA_DB2_UPDATE_PRESERVE_NEW

public static final int SE_XML_SCHEMA_DB2_UPDATE_PRESERVE_NEW
See Also:
Constant Field Values

SE_XML_SCHEMA_DB2_UPDATE_DROP_NEW

public static final int SE_XML_SCHEMA_DB2_UPDATE_DROP_NEW
See Also:
Constant Field Values

SE_XML_SCHEMA_ORA_UPDATE_BINARY_XML

public static final int SE_XML_SCHEMA_ORA_UPDATE_BINARY_XML
See Also:
Constant Field Values

SE_XML_SCHEMA_DELETE_DEFAULT

public static final int SE_XML_SCHEMA_DELETE_DEFAULT
See Also:
Constant Field Values

SE_XML_SCHEMA_ORA_DELETE_CASCADE

public static final int SE_XML_SCHEMA_ORA_DELETE_CASCADE
See Also:
Constant Field Values

SE_XML_SCHEMA_ORA_DELETE_RESTRICT

public static final int SE_XML_SCHEMA_ORA_DELETE_RESTRICT
See Also:
Constant Field Values

SE_XML_SCHEMA_ORA_DELETE_INVALIDATE

public static final int SE_XML_SCHEMA_ORA_DELETE_INVALIDATE
See Also:
Constant Field Values

SE_XML_SCHEMA_ORA_DELETE_CASCADE_FORCE

public static final int SE_XML_SCHEMA_ORA_DELETE_CASCADE_FORCE
See Also:
Constant Field Values

SE_XML_SCHEMA_DB2_STATUS_COMPLETE

public static final int SE_XML_SCHEMA_DB2_STATUS_COMPLETE
See Also:
Constant Field Values

SE_XML_SCHEMA_DB2_STATUS_INCOMPLETE

public static final int SE_XML_SCHEMA_DB2_STATUS_INCOMPLETE
See Also:
Constant Field Values

SE_XML_SCHEMA_DB2_STATUS_REPLACE

public static final int SE_XML_SCHEMA_DB2_STATUS_REPLACE
See Also:
Constant Field Values

SE_XML_SCHEMA_DB2_STATUS_TEMPORARY

public static final int SE_XML_SCHEMA_DB2_STATUS_TEMPORARY
See Also:
Constant Field Values

SE_XML_SCHEMA_ORA_STATUS_LOCAL

public static final int SE_XML_SCHEMA_ORA_STATUS_LOCAL
See Also:
Constant Field Values

SE_XML_SCHEMA_ORA_STATUS_BINARY

public static final int SE_XML_SCHEMA_ORA_STATUS_BINARY
See Also:
Constant Field Values

SE_XML_SCHEMA_ORA_STATUS_HIDDEN

public static final int SE_XML_SCHEMA_ORA_STATUS_HIDDEN
See Also:
Constant Field Values

SE_XML_SCHEMA_ORA_STATUS_HIERARCHY_TYPE_NONE

public static final int SE_XML_SCHEMA_ORA_STATUS_HIERARCHY_TYPE_NONE
See Also:
Constant Field Values

SE_XML_SCHEMA_ORA_STATUS_HIERARCHY_TYPE_RESMETADATA

public static final int SE_XML_SCHEMA_ORA_STATUS_HIERARCHY_TYPE_RESMETADATA
See Also:
Constant Field Values

SE_XML_SCHEMA_ORA_STATUS_HIERARCHY_TYPE_CONTENTS

public static final int SE_XML_SCHEMA_ORA_STATUS_HIERARCHY_TYPE_CONTENTS
See Also:
Constant Field Values
Constructor Detail

SeXmlSchema

public SeXmlSchema(SeConnection conn)
            throws SeException
This constructor creates a new SeXmlSchema object and is used to add an XML Schema.

Parameters:
conn - handle to an open SeConnection.
Throws:
SeException

SeXmlSchema

public SeXmlSchema(SeConnection conn,
                   java.lang.String schemaName)
            throws SeException
This constructor retrieves information of an existing XML schema

Parameters:
conn - handle to an open SeConnection.
schemaName - the XML schema name.
Throws:
SeException
Method Detail

create

public void create()
            throws SeException
This method creates an XML schema. To create a new XML schema, create a new SeXmlSchema object, populate it with information describing the properties of the new XML schema, and then call this function.

Throws:
SeException

delete

public void delete(int delete_options)
            throws SeException
This method deletes an XML schema.The schema name is SQL schema qualified.

Parameters:
delete_options - delete option to be used.
Throws:
SeException

update

public void update(SeXmlSchema new_xmlschema,
                   SeXmlSchema style_sheet,
                   int update_options)
            throws SeException
This method update an existing XML schema.This function updates xml schema object. The source schema will be replaced with new schema. The style sheet is optional and only valid for Oracle.The schema name can be a simple sql name or uri (in case of oracle).

Parameters:
new_xmlschema - the new schema name.
style_sheet - the style sheet to by use. can be null.
update_options - Update options to be used.
Throws:
SeException

getXmlSchemaName

public java.lang.String getXmlSchemaName()
Get the name of the xml schema .

Returns:
name of the xml schema .
Throws:
SeException

setXmlSchemaName

public void setXmlSchemaName(java.lang.String name)
Set the name of the xml schema .

Parameters:
name - the new schema name.
Throws:
SeException

setXmlSchemaCollection

public void setXmlSchemaCollection(SeXmlSchemaCollection xmlCollection)
                            throws SeException
Set xml schema collectin for the Xml Schema object.

Parameters:
xmlCollection - an SeXmlSchemaCollection objeject.
Throws:
SeException

setXmlSchemaPropertyText

public void setXmlSchemaPropertyText(java.lang.String text)
                              throws SeException
Sets the XML schema's property.

Parameters:
text - The schema property.
Throws:
SeException

getXmlSchemaPropertyText

public java.lang.String getXmlSchemaPropertyText()
                                          throws SeException
Gets the XML schema's property.

Throws:
SeException

getXmlSchemaCollection

public SeXmlSchemaCollection getXmlSchemaCollection()
                                             throws SeException
get Xml schema Collection of the Xml Schema.

Throws:
SeException

setRegistrationFlag

public void setRegistrationFlag(int flag)
                         throws SeException
Set the registration flag of the xml schema object.

Parameters:
flag - The registration flat to be set.
Throws:
SeException

getRegistrationFlag

public int getRegistrationFlag()
                        throws SeException
Get the registration flag of the xml schema object.

Throws:
SeException