com.esri.arcgis.geodatabase

Interface IXmlPropertySet2

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IXmlPropertySet2Proxy, XmlPropertySet

public interface IXmlPropertySet2
extends java.io.Serializable

COM Interface 'IXmlPropertySet2'. Generated 9/21/2023 10:01:47 AM from 'X:\ArcGIS\com\server\esriGeoDatabase.tlb'

Description: 'Provides access to members that manage metadata.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IID Deprecated. Internal use only
static int	IID01700025_ef62_47e3_bd1e_7a47d0696541
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
void	deleteProperty(java.lang.String name) Deletes the specified elements.
void	deletePropertyByAttribute(java.lang.String attribute, java.lang.String value, boolean deleteParent) Deletes the elements which have the specified attribute value.
void	deletePropertyByNameAndAttribute(java.lang.String name, java.lang.String attribute, java.lang.String value, boolean deleteParent) Deletes the specified elements which have the specified attribute value.
void	getAttribute(java.lang.String name, java.lang.String attribute, java.lang.Object[] value) Returns the set of values for the specified attribute from the specified elements.
int	getCountX(java.lang.String name) Number of occurrances of an element in the metadata.
void	getPropertiesByAttribute(java.lang.String attribute, java.lang.String value, boolean noValues, java.lang.Object[] tags, java.lang.Object[] values) Returns the set of names and values for elements which have the specified attribute value.
java.lang.String	getXml(java.lang.String name) Returns the XML corresponding to the specified element as a string.
void	initExisting() Initializes an XmlPropertySet and adds the Esri group of elements.
void	initGeneric(java.lang.String rootName) Initializes an XmlPropertySet without adding the Esri group of elements.
boolean	isNew() Indicates if a new XmlPropertySet was created on retrieving the metadata.
boolean	isOverwriteSyncAttribute() Indicates if the Sync attribute will be ignored when setting an element's value.
void	saveAsFile(java.lang.String xslPath, java.lang.String header, boolean outputANSI, java.lang.String[] outPath) Transforms the metadata using an XSL stylesheet if specified, writes out the header if specified, and saves it in a file.
void	setAttribute(java.lang.String name, java.lang.String attribute, java.lang.Object value, int action) Sets the attribute of the specified element.
void	setOverwriteSyncAttribute(boolean overwriteSyncAttributes) Indicates if the Sync attribute will be ignored when setting an element's value.
void	setPropertyX(java.lang.String name, java.lang.Object value, int propType, int action, boolean syncing) Sets the value of the specified element.
void	setXml(java.lang.String xml) Replaces existing metadata with the content defined in the XML.
java.lang.String	simpleGetProperty(java.lang.String name) The values of the specified property.
void	transformImages(java.lang.String path, java.lang.Object[] fileNames) Transforms encoded thumbnail and image enclosures to files and links them into the metadata.

Field Detail

IID01700025_ef62_47e3_bd1e_7a47d0696541

static final int IID01700025_ef62_47e3_bd1e_7a47d0696541

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getCountX

int getCountX(java.lang.String name)
       throws java.io.IOException,
              AutomationException

Number of occurrances of an element in the metadata.

Parameters:

name - The name (in)

Returns:

The count

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPropertiesByAttribute

void getPropertiesByAttribute(java.lang.String attribute,
                              java.lang.String value,
                              boolean noValues,
                              java.lang.Object[] tags,
                              java.lang.Object[] values)
                       throws java.io.IOException,
                              AutomationException

Returns the set of names and values for elements which have the specified attribute value.

Parameters:

attribute - The attribute (in)

value - The value (in)

noValues - The noValues (in)

tags - A Variant (out: use single element array)

values - A Variant (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPropertyX

void setPropertyX(java.lang.String name,
                  java.lang.Object value,
                  int propType,
                  int action,
                  boolean syncing)
           throws java.io.IOException,
                  AutomationException

Sets the value of the specified element.

Parameters:

name - The name (in)

value - A Variant (in)

propType - A com.esri.arcgis.geodatabase.esriXmlPropertyType constant (in)

action - A com.esri.arcgis.geodatabase.esriXmlSetPropertyAction constant (in)

syncing - The syncing (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteProperty

void deleteProperty(java.lang.String name)
             throws java.io.IOException,
                    AutomationException

Deletes the specified elements.

Parameters:

name - The name (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deletePropertyByAttribute

void deletePropertyByAttribute(java.lang.String attribute,
                               java.lang.String value,
                               boolean deleteParent)
                        throws java.io.IOException,
                               AutomationException

Deletes the elements which have the specified attribute value.

Parameters:

attribute - The attribute (in)

value - The value (in)

deleteParent - The deleteParent (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

simpleGetProperty

java.lang.String simpleGetProperty(java.lang.String name)
                            throws java.io.IOException,
                                   AutomationException

The values of the specified property.

Parameters:

name - The name (in)

Returns:

The value

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

saveAsFile

void saveAsFile(java.lang.String xslPath,
                java.lang.String header,
                boolean outputANSI,
                java.lang.String[] outPath)
         throws java.io.IOException,
                AutomationException

Transforms the metadata using an XSL stylesheet if specified, writes out the header if specified, and saves it in a file.

Parameters:

xslPath - The xslPath (in)

header - The header (in)

outputANSI - The outputANSI (in)

outPath - The outPath (in/out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isNew

boolean isNew()
       throws java.io.IOException,
              AutomationException

Indicates if a new XmlPropertySet was created on retrieving the metadata.

Returns:

The isNew

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAttribute

void setAttribute(java.lang.String name,
                  java.lang.String attribute,
                  java.lang.Object value,
                  int action)
           throws java.io.IOException,
                  AutomationException

Sets the attribute of the specified element.

Parameters:

name - The name (in)

attribute - The attribute (in)

value - A Variant (in)

action - A com.esri.arcgis.geodatabase.esriXmlSetPropertyAction constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transformImages

void transformImages(java.lang.String path,
                     java.lang.Object[] fileNames)
              throws java.io.IOException,
                     AutomationException

Transforms encoded thumbnail and image enclosures to files and links them into the metadata.

Parameters:

path - The path (in)

fileNames - A Variant (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

initExisting

void initExisting()
           throws java.io.IOException,
                  AutomationException

Initializes an XmlPropertySet and adds the Esri group of elements.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

initGeneric

void initGeneric(java.lang.String rootName)
          throws java.io.IOException,
                 AutomationException

Initializes an XmlPropertySet without adding the Esri group of elements.

Parameters:

rootName - The rootName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getXml

java.lang.String getXml(java.lang.String name)
                 throws java.io.IOException,
                        AutomationException

Returns the XML corresponding to the specified element as a string.

Parameters:

name - The name (in)

Returns:

The xml

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setXml

void setXml(java.lang.String xml)
     throws java.io.IOException,
            AutomationException

Replaces existing metadata with the content defined in the XML.

Parameters:

xml - The xml (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deletePropertyByNameAndAttribute

void deletePropertyByNameAndAttribute(java.lang.String name,
                                      java.lang.String attribute,
                                      java.lang.String value,
                                      boolean deleteParent)
                               throws java.io.IOException,
                                      AutomationException

Deletes the specified elements which have the specified attribute value.

Parameters:

name - The name (in)

attribute - The attribute (in)

value - The value (in)

deleteParent - The deleteParent (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAttribute

void getAttribute(java.lang.String name,
                  java.lang.String attribute,
                  java.lang.Object[] value)
           throws java.io.IOException,
                  AutomationException

Returns the set of values for the specified attribute from the specified elements.

Parameters:

name - The name (in)

attribute - The attribute (in)

value - A Variant (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOverwriteSyncAttribute

void setOverwriteSyncAttribute(boolean overwriteSyncAttributes)
                        throws java.io.IOException,
                               AutomationException

Indicates if the Sync attribute will be ignored when setting an element's value.

Parameters:

overwriteSyncAttributes - The overwriteSyncAttributes (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isOverwriteSyncAttribute

boolean isOverwriteSyncAttribute()
                          throws java.io.IOException,
                                 AutomationException

Indicates if the Sync attribute will be ignored when setting an element's value.

Returns:

The overwriteSyncAttributes

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.