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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by 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:


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