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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.conversiontools.ImportMetadata
All Implemented Interfaces:
GPTool

public class ImportMetadata
extends AbstractGPTool

Imports metadata to the target item after converting the source item's metadata to ArcGIS metadata, if appropriate. The source and target may be ArcGIS items or stand-alone metadata XML files. The Import 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
ImportMetadata()
          Creates the Import Metadata tool with defaults.
ImportMetadata(Object sourceMetadata, String importType, Object targetMetadata, String enableAutomaticUpdates)
          Creates the Import Metadata tool with the required parameters.
 
Method Summary
 String getEnableAutomaticUpdates()
          Returns the Enable automatic updates parameter of this tool .
 String getImportType()
          Returns the Import Type parameter of this tool .
 Object getOutputMetadata()
          Returns the Output Metadata parameter of this tool (Read only).
 Object getSourceMetadata()
          Returns the Source Metadata parameter of this tool .
 Object getTargetMetadata()
          Returns the Target Metadata 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 setEnableAutomaticUpdates(String enableAutomaticUpdates)
          Sets the Enable automatic updates parameter of this tool .
 void setImportType(String importType)
          Sets the Import Type parameter of this tool .
 void setSourceMetadata(Object sourceMetadata)
          Sets the Source Metadata parameter of this tool .
 void setTargetMetadata(Object targetMetadata)
          Sets the Target Metadata 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

ImportMetadata

public ImportMetadata()
Creates the Import Metadata tool with defaults.

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


ImportMetadata

public ImportMetadata(Object sourceMetadata,
                      String importType,
                      Object targetMetadata,
                      String enableAutomaticUpdates)
Creates the Import 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:
sourceMetadata - the item whose metadata will be imported, or a stand-alone XML file that will be imported. if the source item is a stand-alone file it must contain well-formed XML data.
importType - the format of the metadata that will be imported. by default, the "FROM_ISO_19139" conversion will be performed.
targetMetadata - the item to which the metadata will be imported, or a stand-alone XML file that will be replaced.
enableAutomaticUpdates - null
Method Detail

getSourceMetadata

public Object getSourceMetadata()
Returns the Source Metadata parameter of this tool . This parameter is the item whose metadata will be imported, or a stand-alone XML file that will be imported. if the source item is a stand-alone file it must contain well-formed XML data. This is a required parameter.

Returns:
the Source Metadata

setSourceMetadata

public void setSourceMetadata(Object sourceMetadata)
Sets the Source Metadata parameter of this tool . This parameter is the item whose metadata will be imported, or a stand-alone XML file that will be imported. if the source item is a stand-alone file it must contain well-formed XML data. This is a required parameter.

Parameters:
sourceMetadata - the item whose metadata will be imported, or a stand-alone XML file that will be imported. if the source item is a stand-alone file it must contain well-formed XML data.

getImportType

public String getImportType()
Returns the Import Type parameter of this tool . This parameter is the format of the metadata that will be imported. by default, the "FROM_ISO_19139" conversion will be performed. This is a required parameter.

Returns:
the Import Type

setImportType

public void setImportType(String importType)
Sets the Import Type parameter of this tool . This parameter is the format of the metadata that will be imported. by default, the "FROM_ISO_19139" conversion will be performed. This is a required parameter.

Parameters:
importType - the format of the metadata that will be imported. by default, the "FROM_ISO_19139" conversion will be performed.

getTargetMetadata

public Object getTargetMetadata()
Returns the Target Metadata parameter of this tool . This parameter is the item to which the metadata will be imported, or a stand-alone XML file that will be replaced. This is a required parameter.

Returns:
the Target Metadata

setTargetMetadata

public void setTargetMetadata(Object targetMetadata)
Sets the Target Metadata parameter of this tool . This parameter is the item to which the metadata will be imported, or a stand-alone XML file that will be replaced. This is a required parameter.

Parameters:
targetMetadata - the item to which the metadata will be imported, or a stand-alone XML file that will be replaced.

getEnableAutomaticUpdates

public String getEnableAutomaticUpdates()
Returns the Enable automatic updates parameter of this tool . This is a required parameter.

Returns:
the Enable automatic updates

setEnableAutomaticUpdates

public void setEnableAutomaticUpdates(String enableAutomaticUpdates)
Sets the Enable automatic updates parameter of this tool . This is a required parameter.

Parameters:
enableAutomaticUpdates - null

getOutputMetadata

public Object getOutputMetadata()
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