com.esri.arcgis.geoprocessing
Interface IGPParseString2

All Superinterfaces:

Serializable

All Known Implementing Classes:

GPParseString

public interface IGPParseString2
extends Serializable

Provides access to the properties/methods of a geoprocessing parse string object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

String	checkToken(String inChar, boolean[] pInQuote, boolean[] pTokenDone) Builds a string, one character at a time, returning whether that character is quoted and whether that character is the end of delimited token.
String	doubleToString(double value) Returns the double value as string.
void	initialize(String string, String separator) Initializes the geoprocessing parse string object with the string to be parsed and the string used to separate tokens.
boolean	isNextTokenQuoted() Returns whether the next token to be parsed is enclosed in quotation marks.
boolean	needsQuote(String text) Returns if the string needs to be quoted.
boolean	nextBoolean() Returns the next token parsed from the string as a boolean.
double	nextDouble() Returns the next token parsed from the string as a double.
int	nextLong() Returns the next token parsed from the string as a long.
String	nextSimpleToken() Returns the next simple token parsed from the string.
String	nextToken() Returns the next token parsed from the string.
String	quoteString(String text) Quotes the string if it needs to be quoted.
String	remainingText() Returns the remaining string.
double	stringToDouble(String text) Returns the string as a doulbe value.

Method Detail

initialize

void initialize(String string,
                String separator)
                throws IOException,
                       AutomationException

Initializes the geoprocessing parse string object with the string to be parsed and the string used to separate tokens.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

string - The string (in)

separator - The separator (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

nextToken

String nextToken()
                 throws IOException,
                        AutomationException

Returns the next token parsed from the string.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The token

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

nextSimpleToken

String nextSimpleToken()
                       throws IOException,
                              AutomationException

Returns the next simple token parsed from the string.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The token

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isNextTokenQuoted

boolean isNextTokenQuoted()
                          throws IOException,
                                 AutomationException

Returns whether the next token to be parsed is enclosed in quotation marks.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The quoted

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

checkToken

String checkToken(String inChar,
                  boolean[] pInQuote,
                  boolean[] pTokenDone)
                  throws IOException,
                         AutomationException

Builds a string, one character at a time, returning whether that character is quoted and whether that character is the end of delimited token.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

inChar - The inChar (in)

pInQuote - The pInQuote (out: use single element array)

pTokenDone - The pTokenDone (out: use single element array)

Returns:

The pToken

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remainingText

String remainingText()
                     throws IOException,
                            AutomationException

Returns the remaining string.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The text

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

nextDouble

double nextDouble()
                  throws IOException,
                         AutomationException

Returns the next token parsed from the string as a double.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The token

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

nextLong

int nextLong()
             throws IOException,
                    AutomationException

Returns the next token parsed from the string as a long.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The token

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

nextBoolean

boolean nextBoolean()
                    throws IOException,
                           AutomationException

Returns the next token parsed from the string as a boolean.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The token

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

needsQuote

boolean needsQuote(String text)
                   throws IOException,
                          AutomationException

Returns if the string needs to be quoted.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

text - The text (in)

Returns:

The token

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

quoteString

String quoteString(String text)
                   throws IOException,
                          AutomationException

Quotes the string if it needs to be quoted.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

text - The text (in)

Returns:

The token

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stringToDouble

double stringToDouble(String text)
                      throws IOException,
                             AutomationException

Returns the string as a doulbe value.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

text - The text (in)

Returns:

The token

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

doubleToString

String doubleToString(double value)
                      throws IOException,
                             AutomationException

Returns the double value as string.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

value - The value (in)

Returns:

The token

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.