Skip navigation links

Oracle® Spatial Java API Reference
11g Release 1 (11.1)

B28401-02


oracle.spatial.network
Interface UserDataMetadata

All Superinterfaces:
java.lang.Cloneable, java.io.Serializable

public interface UserDataMetadata
extends java.lang.Cloneable, java.io.Serializable

This class defines the metadata for user data. Data names will directly map to table column names Data Types: are INTEGER, NUMBER, VARCHAR2, and SDO_GEOMETRY Data Length is only for data with types of VARCHAR2


Field Summary
static java.lang.String DATE_TYPE
           
static java.lang.String INTEGER_TYPE
           
static java.lang.String LINK_TABLE_TYPE
           
static java.lang.String NODE_TABLE_TYPE
           
static java.lang.String NUMBER_TYPE
           
static java.lang.String OBJECT_TYPE
           
static java.lang.String PATH_TABLE_TYPE
           
static java.lang.String SDO_GEOMETRY_TYPE
           
static java.lang.String SUBPATH_TABLE_TYPE
           
static java.lang.String TIMESTAMP_TYPE
           
static java.lang.String VARCHAR2_TYPE
           

 

Method Summary
 void addLinkData(java.lang.String dataName, java.lang.String dataType, int dataLength)
          Adds a link user data entry to the metadata
 void addNodeData(java.lang.String dataName, java.lang.String dataType, int dataLength)
          Adds a node user data entry to the metadata
 void addPathData(java.lang.String dataName, java.lang.String dataType, int dataLength)
          Adds a path user data entry to the metadata
 void addSubPathData(java.lang.String dataName, java.lang.String dataType, int dataLength)
          Adds a subpath user data entry to the metadata
 boolean containsLinkUserData(java.lang.String dataName)
          Checks if the given link user data name exists
 boolean containsNodeUserData(java.lang.String dataName)
          Checks if the given node user data name exists
 boolean containsPathUserData(java.lang.String dataName)
          Checks if the given path user data name exists
 boolean containsSubPathUserData(java.lang.String dataName)
          Checks if the given subpath user data name exists
 void deleteLinkData(java.lang.String dataName)
          Deletes a link user data entry from the metadata
 void deleteNodeData(java.lang.String dataName)
          Deletes a node user data entry from the metadata
 void deletePathData(java.lang.String dataName)
          Deletes a path user data entry from the metadata
 void deleteSubPathData(java.lang.String dataName)
          Deletes a subpath user data entry from the metadata
 int getLinkDataLength(java.lang.String dataName)
          Returns the link user data length
 java.lang.String[] getLinkDataNames()
          Returns the link user data names in a String array
 java.lang.String getLinkDataType(java.lang.String dataName)
          Returns the link user data type of the given data name
 java.lang.String getNetworkName()
          Returns the network name
 int getNodeDataLength(java.lang.String dataName)
          Returns the node user data length
 java.lang.String[] getNodeDataNames()
          Returns the node user data names in a String array
 java.lang.String getNodeDataType(java.lang.String dataName)
          Returns the node user data type of the given data name
 int getPathDataLength(java.lang.String dataName)
          Returns the path user data length
 java.lang.String[] getPathDataNames()
          Returns the path user data names in a String array
 java.lang.String getPathDataType(java.lang.String dataName)
          Returns the path user data type of the given data name
 int getSubPathDataLength(java.lang.String dataName)
          Returns the subpath user data length
 java.lang.String[] getSubPathDataNames()
          Returns the subpath user data names in a String array
 java.lang.String getSubPathDataType(java.lang.String dataName)
          Returns the subpath user data type of the given data name
 java.lang.String[] getSupportedDataTypes()
          Returns all surported data type in the user data metadata
 boolean isEmpty()
          Checks if the metadata contains any data
 boolean validDataType(java.lang.String dataType)
          Checks if the given data type is supported

 

Field Detail

NODE_TABLE_TYPE

static final java.lang.String NODE_TABLE_TYPE
See Also:
Constant Field Values

LINK_TABLE_TYPE

static final java.lang.String LINK_TABLE_TYPE
See Also:
Constant Field Values

PATH_TABLE_TYPE

static final java.lang.String PATH_TABLE_TYPE
See Also:
Constant Field Values

SUBPATH_TABLE_TYPE

static final java.lang.String SUBPATH_TABLE_TYPE
See Also:
Constant Field Values

INTEGER_TYPE

static final java.lang.String INTEGER_TYPE
See Also:
Constant Field Values

NUMBER_TYPE

static final java.lang.String NUMBER_TYPE
See Also:
Constant Field Values

VARCHAR2_TYPE

static final java.lang.String VARCHAR2_TYPE
See Also:
Constant Field Values

SDO_GEOMETRY_TYPE

static final java.lang.String SDO_GEOMETRY_TYPE
See Also:
Constant Field Values

DATE_TYPE

static final java.lang.String DATE_TYPE
See Also:
Constant Field Values

TIMESTAMP_TYPE

static final java.lang.String TIMESTAMP_TYPE
See Also:
Constant Field Values

OBJECT_TYPE

static final java.lang.String OBJECT_TYPE
See Also:
Constant Field Values

Method Detail

getNetworkName

java.lang.String getNetworkName()
Returns the network name

getNodeDataNames

java.lang.String[] getNodeDataNames()
Returns the node user data names in a String array

getLinkDataNames

java.lang.String[] getLinkDataNames()
Returns the link user data names in a String array

getPathDataNames

java.lang.String[] getPathDataNames()
Returns the path user data names in a String array

getSubPathDataNames

java.lang.String[] getSubPathDataNames()
Returns the subpath user data names in a String array

getNodeDataType

java.lang.String getNodeDataType(java.lang.String dataName)
Returns the node user data type of the given data name
Parameters:
dataName - node user data name

getLinkDataType

java.lang.String getLinkDataType(java.lang.String dataName)
Returns the link user data type of the given data name
Parameters:
dataName - link user data name

getPathDataType

java.lang.String getPathDataType(java.lang.String dataName)
Returns the path user data type of the given data name
Parameters:
dataName - path user data name

getSubPathDataType

java.lang.String getSubPathDataType(java.lang.String dataName)
Returns the subpath user data type of the given data name
Parameters:
dataName - subpath user data name

getNodeDataLength

int getNodeDataLength(java.lang.String dataName)
Returns the node user data length
Parameters:
dataName - node user data name

getLinkDataLength

int getLinkDataLength(java.lang.String dataName)
Returns the link user data length
Parameters:
dataName - link user data name

getPathDataLength

int getPathDataLength(java.lang.String dataName)
Returns the path user data length
Parameters:
dataName - path user data name

getSubPathDataLength

int getSubPathDataLength(java.lang.String dataName)
Returns the subpath user data length
Parameters:
dataName - path user data name

addNodeData

void addNodeData(java.lang.String dataName,
                 java.lang.String dataType,
                 int dataLength)
                 throws NetworkDataException
Adds a node user data entry to the metadata
Parameters:
dataName - node user data name
dataType - node user data type
dataLength - node user data length if applicable
Throws:
NetworkDataException - if such entry already exists

addLinkData

void addLinkData(java.lang.String dataName,
                 java.lang.String dataType,
                 int dataLength)
                 throws NetworkDataException
Adds a link user data entry to the metadata
Parameters:
dataName - link user data name
dataType - link user data type
dataLength - link user data length if applicable
Throws:
NetworkDataException - if such entry already exists

addPathData

void addPathData(java.lang.String dataName,
                 java.lang.String dataType,
                 int dataLength)
                 throws NetworkDataException
Adds a path user data entry to the metadata
Parameters:
dataName - path user data name
dataType - path user data type
dataLength - path user data length if applicable
Throws:
NetworkDataException - if such entry already exists

addSubPathData

void addSubPathData(java.lang.String dataName,
                    java.lang.String dataType,
                    int dataLength)
                    throws NetworkDataException
Adds a subpath user data entry to the metadata
Parameters:
dataName - subpath user data name
dataType - subpath user data type
dataLength - subpath user data length if applicable
Throws:
NetworkDataException - if such entry already exists

deleteNodeData

void deleteNodeData(java.lang.String dataName)
Deletes a node user data entry from the metadata
Parameters:
dataName - node user data name

deleteLinkData

void deleteLinkData(java.lang.String dataName)
Deletes a link user data entry from the metadata
Parameters:
dataName - link user data name

deletePathData

void deletePathData(java.lang.String dataName)
Deletes a path user data entry from the metadata
Parameters:
dataName - path user data name

deleteSubPathData

void deleteSubPathData(java.lang.String dataName)
Deletes a subpath user data entry from the metadata
Parameters:
dataName - subpath user data name

getSupportedDataTypes

java.lang.String[] getSupportedDataTypes()
Returns all surported data type in the user data metadata
Returns:
an array of String

validDataType

boolean validDataType(java.lang.String dataType)
Checks if the given data type is supported
Parameters:
dataType - data type
Returns:
true if supported, false otherwise

isEmpty

boolean isEmpty()
Checks if the metadata contains any data

containsNodeUserData

boolean containsNodeUserData(java.lang.String dataName)
Checks if the given node user data name exists
Parameters:
dataName - node user data name

containsLinkUserData

boolean containsLinkUserData(java.lang.String dataName)
Checks if the given link user data name exists
Parameters:
dataName - link user data name

containsPathUserData

boolean containsPathUserData(java.lang.String dataName)
Checks if the given path user data name exists
Parameters:
dataName - path user data name

containsSubPathUserData

boolean containsSubPathUserData(java.lang.String dataName)
Checks if the given subpath user data name exists
Parameters:
dataName - subpath user data name

Skip navigation links

Oracle® Spatial Java API Reference
11g Release 1 (11.1)

B28401-02


Copyright © 2007, 2008, Oracle. All Rights Reserved.