com.esri.arcgis.geoprocessing.tools.conversiontools
Class SynchronizeMetadata

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.conversiontools.SynchronizeMetadata

All Implemented Interfaces:

GPTool

public class SynchronizeMetadata
extends AbstractGPTool

Automatically updates an ArcGIS item's metadata with the current properties of the item. The Synchronize Metadata tool is contained in the Conversion Tools tool box.

Usage tips:

• By default, metadata is automatically updated when anyone who has write access to the ArcGIS item views its metadata. Metadata can also be synchronized by running this tool. The option to turn off synchronization when you view metadata doesn't affect how this tool operates.
• If someone edits an ArcGIS item's data or changes its properties and does not view the metadata, the properties recorded in the metadata are out of date with the actual properties of the item. If you were to use or publish the item's metadata in this state without first running this tool the information in the metadata would not be current.The , , , and tools all update the metadata automatically before performing other operations. The and tools automatically update the metadata after performing other operations.If your organization's metadata workflow incorporates other operations or tools that don't synchronize the metadata you may want to write a Python script that would run this tool as needed. For example, if you use a utility that publishes metadata for all items in a geodatabase to a metadata catalog nightly, ideally you would synchronize the metadata content nightly before publishing to ensure the published information is always current.
• If you try to synchronize a stand-alone metadata XML file, the tool will complete successfully but the XML file will remain unchanged.
• The Source Metadata parameter has a complex data type. If you use this tool in a model, create a variable for the Source Metadata parameter in ModelBuilder by right-clicking the tool, pointing to Make VariableFrom ParameterSource Metadata.
• When using this tool in ModelBuilder, the Output Metadata parameter is derived from the Source Metadata parameter.
• If you do not have write access to the ArcGIS item or its metadata or the stand-alone metadata XML file that you are trying to modify, this tool will complete successfully but the item's original metadata will remain unchanged.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

SynchronizeMetadata()
Creates the Synchronize Metadata tool with defaults.

SynchronizeMetadata(Object source, String synctype)
Creates the Synchronize Metadata tool with the required parameters.

Method Summary

Object	getOutput() Returns the Output Metadata parameter of this tool (Read only).
Object	getSource() Returns the Source Metadata parameter of this tool .
String	getSynctype() Returns the Synchronize Type parameter of this tool .
String	getToolboxAlias() Returns the alias of the tool box containing this tool.
String	getToolboxName() Returns the name of the tool box containing this tool.
String	getToolName() Returns the name of this tool.
void	setSource(Object source) Sets the Source Metadata parameter of this tool .
void	setSynctype(String synctype) Sets the Synchronize Type parameter of this tool .

Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

getParameterValues, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SynchronizeMetadata

public SynchronizeMetadata()

Creates the Synchronize Metadata tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.

SynchronizeMetadata

public SynchronizeMetadata(Object source,
                           String synctype)

Creates the Synchronize Metadata tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:

source - the item whose metadata will be synchronized.

synctype - the type of synchronization that will take place.

Method Detail

getSource

public Object getSource()

Returns the Source Metadata parameter of this tool . This parameter is the item whose metadata will be synchronized. This is a required parameter.

Returns:

the Source Metadata

setSource

public void setSource(Object source)

Sets the Source Metadata parameter of this tool . This parameter is the item whose metadata will be synchronized. This is a required parameter.

Parameters:

source - the item whose metadata will be synchronized.

getSynctype

public String getSynctype()

Returns the Synchronize Type parameter of this tool . This parameter is the type of synchronization that will take place. This is a required parameter.

Returns:

the Synchronize Type

setSynctype

public void setSynctype(String synctype)

Sets the Synchronize Type parameter of this tool . This parameter is the type of synchronization that will take place. This is a required parameter.

Parameters:

synctype - the type of synchronization that will take place.

getOutput

public Object getOutput()

Returns the Output Metadata parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Metadata

getToolName

public String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias