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

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

public class MDPublisher
extends AbstractGPTool

Publishes metadata to a metadata catalog such as an ArcIMS Metadata Service. The Metadata Publisher 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
MDPublisher()
          Creates the Metadata Publisher tool with defaults.
MDPublisher(Object source, Object publisher)
          Creates the Metadata Publisher tool with the required parameters.
 
Method Summary
 Object getOutput()
          Returns the Output Metadata parameter of this tool (Read only).
 String getPassword()
          Returns the Password parameter of this tool .
 Object getPublisher()
          Returns the Publisher parameter of this tool .
 String getService()
          Returns the Service Name parameter of this tool .
 Object getSource()
          Returns the Source 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.
 String getUrl()
          Returns the Service URL parameter of this tool .
 String getUser()
          Returns the User Name parameter of this tool .
 void setPassword(String password)
          Sets the Password parameter of this tool .
 void setPublisher(Object publisher)
          Sets the Publisher parameter of this tool .
 void setService(String service)
          Sets the Service Name parameter of this tool .
 void setSource(Object source)
          Sets the Source Metadata parameter of this tool .
 void setUrl(String url)
          Sets the Service URL parameter of this tool .
 void setUser(String user)
          Sets the User Name 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

MDPublisher

public MDPublisher()
Creates the Metadata Publisher tool with defaults.

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


MDPublisher

public MDPublisher(Object source,
                   Object publisher)
Creates the Metadata Publisher 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 published, or a stand-alone XML file that will be published.
publisher - an XML file that defines how the metadata will be published.
Method Detail

getSource

public Object getSource()
Returns the Source Metadata parameter of this tool . This parameter is the item whose metadata will be published, or a stand-alone XML file that will be published. 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 published, or a stand-alone XML file that will be published. This is a required parameter.

Parameters:
source - the item whose metadata will be published, or a stand-alone XML file that will be published.

getPublisher

public Object getPublisher()
Returns the Publisher parameter of this tool . This parameter is an XML file that defines how the metadata will be published. This is a required parameter.

Returns:
the Publisher

setPublisher

public void setPublisher(Object publisher)
Sets the Publisher parameter of this tool . This parameter is an XML file that defines how the metadata will be published. This is a required parameter.

Parameters:
publisher - an XML file that defines how the metadata will be published.

getUrl

public String getUrl()
Returns the Service URL parameter of this tool . This parameter is the URL of a Web Service that hosts the metadata catalog, if appropriate. for example, the URL of an ArcIMS Server that provides a Metadata Service. This is an optional parameter.

Returns:
the Service URL

setUrl

public void setUrl(String url)
Sets the Service URL parameter of this tool . This parameter is the URL of a Web Service that hosts the metadata catalog, if appropriate. for example, the URL of an ArcIMS Server that provides a Metadata Service. This is an optional parameter.

Parameters:
url - the URL of a Web Service that hosts the metadata catalog, if appropriate. for example, the URL of an ArcIMS Server that provides a Metadata Service.

getService

public String getService()
Returns the Service Name parameter of this tool . This parameter is the name of the service to which you want to publish, if appropriate. for example, for an ArcIMS Metadata Service this is the case-sensitive name of the Metadata Service. This is an optional parameter.

Returns:
the Service Name

setService

public void setService(String service)
Sets the Service Name parameter of this tool . This parameter is the name of the service to which you want to publish, if appropriate. for example, for an ArcIMS Metadata Service this is the case-sensitive name of the Metadata Service. This is an optional parameter.

Parameters:
service - the name of the service to which you want to publish, if appropriate. for example, for an ArcIMS Metadata Service this is the case-sensitive name of the Metadata Service.

getUser

public String getUser()
Returns the User Name parameter of this tool . This parameter is the name used to access the metadata catalog when publishing documents, if appropriate. for example, when publishing documents to an ArcIMS Metadata Service you must log in to the service using a name that has been granted metadata_publisher privileges or a higher privilege. This is an optional parameter.

Returns:
the User Name

setUser

public void setUser(String user)
Sets the User Name parameter of this tool . This parameter is the name used to access the metadata catalog when publishing documents, if appropriate. for example, when publishing documents to an ArcIMS Metadata Service you must log in to the service using a name that has been granted metadata_publisher privileges or a higher privilege. This is an optional parameter.

Parameters:
user - the name used to access the metadata catalog when publishing documents, if appropriate. for example, when publishing documents to an ArcIMS Metadata Service you must log in to the service using a name that has been granted metadata_publisher privileges or a higher privilege.

getPassword

public String getPassword()
Returns the Password parameter of this tool . This parameter is the password you used to access the metadata catalog when publishing documents, if appropriate. for example, when publishing documents to an ArcIMS Metadata Service, this is the password required to log in with the specified User Name. This is an optional parameter.

Returns:
the Password

setPassword

public void setPassword(String password)
Sets the Password parameter of this tool . This parameter is the password you used to access the metadata catalog when publishing documents, if appropriate. for example, when publishing documents to an ArcIMS Metadata Service, this is the password required to log in with the specified User Name. This is an optional parameter.

Parameters:
password - the password you used to access the metadata catalog when publishing documents, if appropriate. for example, when publishing documents to an ArcIMS Metadata Service, this is the password required to log in with the specified User Name.

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