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

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

All Implemented Interfaces:

GPTool

public class MDPublisher
extends AbstractGPTool

This tool requires the Microsoft .NET Framework 2.0. These tools are installed with the .NET Support install option. Publishes an The Metadata Publisher tool is contained in the Conversion Tools tool box.

Software restrictions: none

Usage tips:

• If you connect to ArcIMS in ArcCatalog with the same user name and password provided with this tool, the Metadata Service's icon will show a hand holding a pencil if you have permission to publish documents to that service.

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 - Data Element, the item whose metadata will be published, or a stand-alone XML file that will be published.

publisher - File, the ArcIMS Metadata Service publisher provided with ArcGIS Desktop, arcimsmd.xml, can be found in the \Metadata\Publisher folder. This publisher looks for information in the content of the metadata or XML document and uses the information it finds to construct an appropriate ArcXML PUBLISH_METADATA request. This publisher follows the same procedure as publishing documents in ArcCatalog when examining the content of the data; elements defined by the FGDC metadata standard are checked first, and if relevant information isn't found the publisher will check the contents of elements that follow the ISO 19115 metadata standard. This publisher does not validate a document's content to see if it contains the information required by the Metadata Explorer application.

Method Detail

getSource

public Object getSource()

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

Parameters:

source - Data Element, 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 File, the ArcIMS Metadata Service publisher provided with ArcGIS Desktop, arcimsmd.xml, can be found in the \Metadata\Publisher folder. This publisher looks for information in the content of the metadata or XML document and uses the information it finds to construct an appropriate ArcXML PUBLISH_METADATA request. This publisher follows the same procedure as publishing documents in ArcCatalog when examining the content of the data; elements defined by the FGDC metadata standard are checked first, and if relevant information isn't found the publisher will check the contents of elements that follow the ISO 19115 metadata standard. This publisher does not validate a document's content to see if it contains the information required by the Metadata Explorer application. This is a required parameter.

Returns:

the Publisher

setPublisher

public void setPublisher(Object publisher)

Sets the Publisher parameter of this tool . This parameter is File, the ArcIMS Metadata Service publisher provided with ArcGIS Desktop, arcimsmd.xml, can be found in the \Metadata\Publisher folder. This publisher looks for information in the content of the metadata or XML document and uses the information it finds to construct an appropriate ArcXML PUBLISH_METADATA request. This publisher follows the same procedure as publishing documents in ArcCatalog when examining the content of the data; elements defined by the FGDC metadata standard are checked first, and if relevant information isn't found the publisher will check the contents of elements that follow the ISO 19115 metadata standard. This publisher does not validate a document's content to see if it contains the information required by the Metadata Explorer application. This is a required parameter.

Parameters:

publisher - File, the ArcIMS Metadata Service publisher provided with ArcGIS Desktop, arcimsmd.xml, can be found in the \Metadata\Publisher folder. This publisher looks for information in the content of the metadata or XML document and uses the information it finds to construct an appropriate ArcXML PUBLISH_METADATA request. This publisher follows the same procedure as publishing documents in ArcCatalog when examining the content of the data; elements defined by the FGDC metadata standard are checked first, and if relevant information isn't found the publisher will check the contents of elements that follow the ISO 19115 metadata standard. This publisher does not validate a document's content to see if it contains the information required by the Metadata Explorer application.

getUrl

public String getUrl()

Returns the Service URL parameter of this tool . This parameter is String, 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 String, 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 - String, 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 String, 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 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 String, 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 of the Metadata Service. This is an optional parameter.

Parameters:

service - String, 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 of the Metadata Service.

getUser

public String getUser()

Returns the User Name parameter of this tool . This parameter is String, the name you use to log in to the metadata catalog when publishing documents. For example, when publishing documents to an ArcIMS Metadata Service, you must use a log in name that has been granted metadata_publisher privileges for accessing the Metadata Service. 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 String, the name you use to log in to the metadata catalog when publishing documents. For example, when publishing documents to an ArcIMS Metadata Service, you must use a log in name that has been granted metadata_publisher privileges for accessing the Metadata Service. This is an optional parameter.

Parameters:

user - String, the name you use to log in to the metadata catalog when publishing documents. For example, when publishing documents to an ArcIMS Metadata Service, you must use a log in name that has been granted metadata_publisher privileges for accessing the Metadata Service.

getPassword

public String getPassword()

Returns the Password parameter of this tool . This parameter is String, the password you use to log in to the metadata catalog when publishing documents. This is an optional parameter.

Returns:

the Password

setPassword

public void setPassword(String password)

Sets the Password parameter of this tool . This parameter is String, the password you use to log in to the metadata catalog when publishing documents. This is an optional parameter.

Parameters:

password - String, the password you use to log in to the metadata catalog when publishing documents.

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