com.esri.arcgis.geodatabase
Interface IMetadata

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

CadastralFabric, CadastralFabricName, CadDrawingName, CoverageFeatureClassName, CoverageName, DEAddressLocator, DEArcInfoTable, DECadastralFabric, DECadDrawingDataset, DECatalogRoot, DECoverage, DECoverageFeatureClass, DEDbaseTable, DEDiskConnection, DEFeatureClass, DEFeatureDataset, DEFile, DEFolder, DEGeoDataServer, DEGeometricNetwork, DELayer, DEMapDocument, DENetworkDataset, DEPrjFile, DERasterBand, DERasterCatalog, DERasterDataset, DERelationshipClass, DERemoteDatabaseFolder, DERepresentationClass, DEShapeFile, DESpatialReferencesFolder, DETable, DETextFile, DETin, DEToolbox, DETopology, DEVPFCoverage, DEVPFTable, DEWorkspace, FeatureClassName, FeatureDatasetName, FgdbFeatureClassName, FgdbTableName, GeometricNetwork, GeometricNetworkName, IMetadataProxy, IMSMetadataServiceName, IMSServiceName, LocatorName, NetCDFFeatureClass, NetCDFRasterDataset, NetCDFRasterDatasetName, NetworkDataset, NetworkDatasetName, ObjectClassName, RasterBand, RasterBandName, RasterCatalogName, RasterDataset, RasterDatasetName, RelationshipClassName, SchematicDataset, SchematicDatasetName, SchematicDiagram, SchematicFolder, SchematicFolderName, TableName, Terrain, TerrainName, Tin, TinName, Topology, TopologyName, WorkspaceDefinition

public interface IMetadata

extends java.io.Serializable

Provides access to members that manage and update metadata.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Remarks

The IMetadata interface is implemented by the GxMetadata object and all other objects that support metadata (the bulk of GxObject types). Use this interface when you want to access the set of metadata associated with an object or you want to create new metadata for the object.

Method Summary

IPropertySet	getMetadata() The PropertySet containing metadata.
void	setMetadata(IPropertySet ppPropertySet) The PropertySet containing metadata.
void	synchronize(int action, int interval) Updates metadata with the current properties; may create metadata if it doesn't already exist.

Method Detail

getMetadata

public IPropertySet getMetadata()
                         throws java.io.IOException,
                                AutomationException

The PropertySet containing metadata.

Supported Platforms

Windows, Solaris, Linux

Remarks

The variable to hold the data must be of IPropertySet data type.

The metadata property is frequently used to save, or update, changes to metadata documents that have taken place through methods available on the IPropertySet, IXmlPropertySet, and/or IXmlPropertySet2 interfaces.

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMetadata

public void setMetadata(IPropertySet ppPropertySet)
                 throws java.io.IOException,
                        AutomationException

The PropertySet containing metadata.

Supported Platforms

Windows, Solaris, Linux

Parameters:

ppPropertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

synchronize

public void synchronize(int action,
                        int interval)
                 throws java.io.IOException,
                        AutomationException

Updates metadata with the current properties; may create metadata if it doesn't already exist.

Supported Platforms

Windows, Solaris, Linux

Description

The Synchronize method is used to extract metadata properties from an object and write those properties to the metadata .xml. Depending on the value of the esriMetaSyncAction, the Synchronize method may generate a new set of metadata if it doesn't already exist.

Parameters:

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

interval - The interval (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.