|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPropertySet
Provides access to members for managing a PropertySet.
The IPropertySet interface contains methods to set and retrieve the collection of named value pairs in the PropertySet.
Method Summary | |
---|---|
void |
getAllProperties(Object[] names,
Object[] values)
The name and value of all the properties in the property set. |
int |
getCount()
The number of properties contained in the property set. |
void |
getProperties(Object names,
Object[] values)
The values of the specified properties. |
Object |
getProperty(String name)
The value of the specified property. |
boolean |
isEqual(IPropertySet propertySet)
True if the property set is the same as the input property set. |
void |
removeProperty(String name)
Removes a property from the set. |
void |
setProperties(Object names,
Object values)
The values of the specified properties. |
void |
setProperty(String name,
Object value)
The value of the specified property. |
Method Detail |
---|
int getCount() throws IOException, AutomationException
The Count value will always be one when used with the esriGeodatabase.XmlPropertySet coclass. For more information, see the remarks for the XmlPropertySet coclass.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.com.esri.arcgis.system.IXmlPropertySet
,
com.esri.arcgis.system.IXmlPropertySet2
Object getProperty(String name) throws IOException, AutomationException
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IPropertySet.getProperties(java.lang.Object, Object[])
,
IPropertySet.getAllProperties(Object[], Object[])
void getProperties(Object names, Object[] values) throws IOException, AutomationException
The GetProperties method returns values from a PropertySet CoClass.
names
- A Variant (in)values
- A Variant (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IPropertySet.getAllProperties(Object[], Object[])
,
IPropertySet.getProperty(String)
void getAllProperties(Object[] names, Object[] values) throws IOException, AutomationException
The GetAllProperties retrieves all names and values in the property set.
names
- A Variant (out: use single element array)values
- A Variant (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IPropertySet.getProperties(java.lang.Object, Object[])
,
IPropertySet.getProperty(String)
void setProperty(String name, Object value) throws IOException, AutomationException
The Name parameter uses XSL Patterns to specify metadata elements. Additional information on XSL can be found in the the IXmlPropertySet documentation.
name
- The name (in)value
- A Variant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.com.esri.arcgis.system.IXmlPropertySet
,
com.esri.arcgis.system.IXmlPropertySet2
,
IPropertySet.setProperties(java.lang.Object, java.lang.Object)
void setProperties(Object names, Object values) throws IOException, AutomationException
Using the Name parameter to locate the specified element, the SetProperties method populates the elements, or adds an new element if it already exists, and sets the value to the coorseponding Values parameter.
The Name parameter uses XSL Patterns to specify metadata elements. Additional information on XSL can be found in the the IXmlPropertySet documentation.
esriXmlSetPropertyAction constants are NOT available to handle situations where an element value already exists. Upon encountering elements that already have values, the new values will replace or add values to existing elements. For more control dealing with elements the IXmlPropertySet::SetPropertyX should be used.
In order to populated nodes further along in the Xml tree, nodes necessary to navigate must first be established. For instance in order to populate the "idinfo/ptcontact/cntinfo/cntperp/cntorg" node each subsequent nodes, "idinfo", "idinfo/ptcontact", "idinfo/ptcontact/cntinfo" and "idinfo/ptcontact/cntinfo/cntperp" must already be in place.
names
- A Variant (in)values
- A Variant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IPropertySet.setProperty(String, java.lang.Object)
,
com.esri.arcgis.system.IXmlPropertySet
,
This method is not interop compliant and hence unsupported in Java. Use setProperty() instead.
boolean isEqual(IPropertySet propertySet) throws IOException, AutomationException
This method indicates whether two property sets are equal.
Note that it will always return false if the property set is an esriGeodatabase.XmlPropertySet (for metadata). See the XmlPropertySet coclass' documentation for more information.
propertySet
- A reference to a com.esri.arcgis.system.IPropertySet (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void removeProperty(String name) throws IOException, AutomationException
name
- The name (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.com.esri.arcgis.system.IXmlPropertySet
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |