com.esri.arcgis.geoprocessing.tools.coveragetools
Class S57Arc

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.coveragetools.S57Arc

All Implemented Interfaces:

GPTool

public class S57Arc
extends AbstractGPTool

Converts data from S-57 format to Arc/Iinfo coverages. The Import From S57 tool is contained in the Coverage Tools tool box.

Usage tips:

• S-57 is a data standard developed by the International Hydrographic Organization (IHO) to be used for the exchange of digital hydrographic data.
• Each S-57 exchange dataset contains one catalog file and one or more base cells. Import From S57 reads the catalog file, converts it to an INFO file, then converts each base cell file to one or two Arc/Info coverages. One of these coverages will contain all the isolated nodes (for instance, spatial point objects); the other coverage will contain all the spatial and feature objects plus the data descriptive information.
• The Import From S57 importer creates either one or two Arc/Info coverages per base cell file, depending on the types of objects contained within the file.
• Import From S57 creates an INFO file to capture all the objects being converted for each base cell file. The resulting file is called coverage.object and has the following items: NAME has a content of Record Identifier, LNAM has a content of Feature object long name, CLASS contains feature class, and PRIM contains the Object's spatial primitive (VI, VC, VE, VF, FP, FN, FL, FA, and CF). This INFO file will have a record for each spatial and feature object being converted. The NAME and PRIM columns apply to both spatial and feature objects;however, the LNAM and CLASS columns only apply to feature objects. You can use this table to quickly identify what sort of objects exist in the base cell file.
• This INFO file is an enhancement to the importer and is not required by the exporter ().

Field Summary

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

vals

Constructor Summary

S57Arc()
Creates the Import From S57 tool with defaults.

S57Arc(Object inS57File, Object outWorkspace)
Creates the Import From S57 tool with the required parameters.

Method Summary

String	getClean() Returns the Clean feature topology parameter of this tool .
Object	getInS57File() Returns the Input S57 File parameter of this tool .
Object	getOutWorkspace() Returns the Output Workspace 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	setClean(String clean) Sets the Clean feature topology parameter of this tool .
void	setInS57File(Object inS57File) Sets the Input S57 File parameter of this tool .
void	setOutWorkspace(Object outWorkspace) Sets the Output Workspace 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

S57Arc

public S57Arc()

Creates the Import From S57 tool with defaults.

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

S57Arc

public S57Arc(Object inS57File,
              Object outWorkspace)

Creates the Import From S57 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:

inS57File - the data catalog filename or base cell filename in the S-57 exchange set. If a catalog filename is specified, all base cell files listed in the catalog file will be converted. If a base cell filename is specified, only that base cell file will be converted.

outWorkspace - the workspace where all output coverages will be written.

Method Detail

getInS57File

public Object getInS57File()

Returns the Input S57 File parameter of this tool . This parameter is the data catalog filename or base cell filename in the S-57 exchange set. If a catalog filename is specified, all base cell files listed in the catalog file will be converted. If a base cell filename is specified, only that base cell file will be converted. This is a required parameter.

Returns:

the Input S57 File

setInS57File

public void setInS57File(Object inS57File)

Sets the Input S57 File parameter of this tool . This parameter is the data catalog filename or base cell filename in the S-57 exchange set. If a catalog filename is specified, all base cell files listed in the catalog file will be converted. If a base cell filename is specified, only that base cell file will be converted. This is a required parameter.

Parameters:

inS57File - the data catalog filename or base cell filename in the S-57 exchange set. If a catalog filename is specified, all base cell files listed in the catalog file will be converted. If a base cell filename is specified, only that base cell file will be converted.

getOutWorkspace

public Object getOutWorkspace()

Returns the Output Workspace parameter of this tool . This parameter is the workspace where all output coverages will be written. This is a required parameter.

Returns:

the Output Workspace

setOutWorkspace

public void setOutWorkspace(Object outWorkspace)

Sets the Output Workspace parameter of this tool . This parameter is the workspace where all output coverages will be written. This is a required parameter.

Parameters:

outWorkspace - the workspace where all output coverages will be written.

getClean

public String getClean()

Returns the Clean feature topology parameter of this tool . This parameter is specifies whether to run the Clean command. This is an optional parameter.

Returns:

the Clean feature topology

setClean

public void setClean(String clean)

Sets the Clean feature topology parameter of this tool . This parameter is specifies whether to run the Clean command. This is an optional parameter.

Parameters:

clean - specifies whether to run the Clean command.

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