Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference
11g Release 1 (11.1.1.6.0)

E13403-07

oracle.javatools.parser.plsql.data
Interface PlsqlTypedef

All Superinterfaces:
PlsqlHasName, PlsqlNode
All Known Implementing Classes:
PtnodTypedef

public interface PlsqlTypedef
extends PlsqlNode, PlsqlHasName

A Plsql type definition, which is characterized by "TYPE id IS ...". Also handles a plsql subtype definition, which is characterized by "SUBTYPE id IS ...". This is different from PlsqlType which is a type mark, used to denote the types of objects (e.g. local variables) and parameters.


Method Summary
 PlsqlType getArrayComponentType()
          Valid if this is a PTNOD_UNCNSTRND_ARRAY_DEF.
 PlsqlType getArrayIndexType()
          Valid if this is a PTNOD_UNCNSTRND_ARRAY_DEF.
 PlsqlName getArrayLength()
          Valid if this is a PTNOD_C_ARRAY_DEF.
 PlsqlType getCursorReturnType()
          Valid if this is a PTNOD_REF_CURSOR_TY_DEF.
 PlsqlName[] getEnumeration()
          Valid if this is a PTNOD_ENUM_TY_DEF.
 PlsqlVariable[] getRecordColumns()
          Valid if this is a PTNOD_RECORD_TY_DEF.
 PlsqlType getSubtype()
          Valid if this is a PTNOD_SUBTY_DEF.
 PlsqlType getTableType()
          Valid if this is a PTNOD_TBL_TY_DEF.
 
Methods inherited from interface oracle.javatools.parser.plsql.data.PlsqlHasName
getName
 
Methods inherited from interface oracle.javatools.parser.plsql.data.PlsqlNode
getStartOffset, getTreeKind
 

Method Detail

getSubtype

PlsqlType getSubtype()
Valid if this is a PTNOD_SUBTY_DEF. Follows the syntax of "SUBTYPE name is type".

Returns:
the sub type.

getCursorReturnType

PlsqlType getCursorReturnType()
Valid if this is a PTNOD_REF_CURSOR_TY_DEF. Follows the syntax of "TYPE name IS REF CURSOR RETURN return_type". The RETURN part is optional.

Returns:
the (optional) cursor return type.

getEnumeration

PlsqlName[] getEnumeration()
Valid if this is a PTNOD_ENUM_TY_DEF. Follows the syntax of "TYPE name IS ( enumeration )".

Returns:
a list of the enumerated identifiers.

getRecordColumns

PlsqlVariable[] getRecordColumns()
Valid if this is a PTNOD_RECORD_TY_DEF. Follows the syntax of "TYPE name IS RECORD( columns )".

Returns:
a list of the columns.

getTableType

PlsqlType getTableType()
Valid if this is a PTNOD_TBL_TY_DEF. Follows the syntax of "TYPE name is TABLE( columns )".

Returns:
the PlsqlType for the "TABLE( columns )" portion.

getArrayComponentType

PlsqlType getArrayComponentType()
Valid if this is a PTNOD_UNCNSTRND_ARRAY_DEF. Follows the syntax "TYPE name IS TABLE OF component_type INDEX by index_type". Valid if this is a PTNOD_C_ARRAY_DEF. Follows the syntax "TYPE name IS ARRAY( length ) of component_type.

Returns:
The component (element) type of this array.

getArrayIndexType

PlsqlType getArrayIndexType()
Valid if this is a PTNOD_UNCNSTRND_ARRAY_DEF. Follows the syntax "TYPE name IS TABLE OF component_type INDEX by index_type".

Returns:
The index type of this array.

getArrayLength

PlsqlName getArrayLength()
Valid if this is a PTNOD_C_ARRAY_DEF. Follows the syntax "TYPE name IS ARRAY( length ) of component_type".


Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference
11g Release 1 (11.1.1.6.0)

E13403-07

Copyright © 1997, 2011, Oracle. All rights reserved.