com.crystaldecisions.sdk.occa.report.data
Class Procedure

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.data.Table
      extended by com.crystaldecisions.sdk.occa.report.data.Procedure
All Implemented Interfaces:
IProcedure, ITable, IClone
Direct Known Subclasses:
CommandTable

public class Procedure
extends Table
implements IProcedure, IClone

This object represents a procedure that is stored in the database. These procedures are referred to as "stored procedures."

Procedures are stored in the database to avoid undue network traffic. For example, a long SQL statement can be stored in the database to avoid passing it back and forth over the network. It is also possible for the stored procedure to have parameters. In this case, only the argument values need to be transferred across the network. If a report connects to a database that has a stored procedure, and that stored procedure has parameters, the IDataDefinition.getParameterFields() method will return these parameters. You cannot change the definition of these parameters, but it is possible to modify their current values. Additionally, the procedure is stored in the table in a manner similar to a normal record. Use the com.crystaldecisions.sdk.occa.report.application.RowsetController#browseFieldValues method to examine the contents of the stored procedure.

Use the interface IProcedure to get and set the current values for the parameters of stored procedures, unless you are cloning or copying the object.


Constructor Summary
Procedure()
           
Procedure(IProcedure src)
           
 
Method Summary
 java.lang.Object clone(boolean deepClone)
           
 void copyTo(java.lang.Object destObject, boolean deepCopy)
           
 java.lang.Object createMember(java.lang.String eleName, org.xml.sax.Attributes attrs, XMLSerializationContext ctxt, java.util.Map objState, boolean[] bLoaded)
           For internal use only.
 void endElement(java.lang.String eleName, java.util.Map objState)
          For internal use only.
 void enumerateMembers(IMemberVisitor visitor)
           
 DataSourceParameterFormulas getParameterFormulas()
          For internal use only.
 Fields<IParameterField> getParameters()
          Gets the stored procedure parameters as Fields objects.
 boolean hasContent(java.lang.Object srcProcedure)
           
 void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
          For internal use only.
 void save(XMLWriter writer, java.lang.String sTag, XMLSerializationContext ctxt)
          For internal use only.
 void save(XMLWriter writer, XMLSerializationContext ctxt)
          For internal use only.
 void saveContents(XMLWriter writer, XMLSerializationContext ctxt)
          For internal use only.
 void setParameterFormulas(DataSourceParameterFormulas parameterFormulas)
          For internal use only.
 void setParameters(Fields<IParameterField> parameters)
          Sets the stored procedure parameters as Fields objects.
 void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
           For internal use only.
 
Methods inherited from class com.crystaldecisions.sdk.occa.report.data.Table
doControllerModification, getAlias, getConnection, getConnectionInfo, getControllableMixin, getDataFields, getDescription, getIndexes, getName, getQualifiedName, isDirectlyControllable, setAlias, setConnection, setConnectionInfo, setDataFields, setDescription, setIndexes, setName, setQualifiedName
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.crystaldecisions.sdk.occa.report.data.ITable
getAlias, getConnection, getConnectionInfo, getDataFields, getDescription, getIndexes, getName, getQualifiedName, setAlias, setConnection, setConnectionInfo, setDataFields, setDescription, setIndexes, setName, setQualifiedName
 

Constructor Detail

Procedure

public Procedure(IProcedure src)

Procedure

public Procedure()
Method Detail

clone

public java.lang.Object clone(boolean deepClone)
Overrides:
clone in class Table

copyTo

public void copyTo(java.lang.Object destObject,
                   boolean deepCopy)
Overrides:
copyTo in class Table

createMember

public java.lang.Object createMember(java.lang.String eleName,
                                     org.xml.sax.Attributes attrs,
                                     XMLSerializationContext ctxt,
                                     java.util.Map objState,
                                     boolean[] bLoaded)

For internal use only.

Overrides:
createMember in class Table

endElement

public void endElement(java.lang.String eleName,
                       java.util.Map objState)

For internal use only.

Overrides:
endElement in class Table

getParameters

public Fields<IParameterField> getParameters()
Description copied from interface: IProcedure
Gets the stored procedure parameters as Fields objects.

Specified by:
getParameters in interface IProcedure
Returns:
The parameters as Fields objects.

getParameterFormulas

public DataSourceParameterFormulas getParameterFormulas()
For internal use only.


hasContent

public boolean hasContent(java.lang.Object srcProcedure)
Overrides:
hasContent in class Table

readElement

public void readElement(java.lang.String eleName,
                        java.lang.String sVal,
                        org.xml.sax.Attributes attrs,
                        java.util.Map objState)

For internal use only.

Overrides:
readElement in class Table

save

public void save(XMLWriter writer,
                 XMLSerializationContext ctxt)
          throws java.io.IOException

For internal use only.

Overrides:
save in class Table
Throws:
java.io.IOException

save

public void save(XMLWriter writer,
                 java.lang.String sTag,
                 XMLSerializationContext ctxt)
          throws java.io.IOException

For internal use only.

Overrides:
save in class Table
Throws:
java.io.IOException

saveContents

public void saveContents(XMLWriter writer,
                         XMLSerializationContext ctxt)
                  throws java.io.IOException

For internal use only.

Overrides:
saveContents in class Table
Throws:
java.io.IOException

setParameters

public void setParameters(Fields<IParameterField> parameters)
Description copied from interface: IProcedure
Sets the stored procedure parameters as Fields objects.

Specified by:
setParameters in interface IProcedure
Parameters:
parameters - The parameters as Fields objects.

setParameterFormulas

public void setParameterFormulas(DataSourceParameterFormulas parameterFormulas)
For internal use only.


startElement

public void startElement(java.lang.String eleName,
                         java.util.Map objState,
                         org.xml.sax.Attributes attrs)
Description copied from class: Table

For internal use only.

Overrides:
startElement in class Table

enumerateMembers

public void enumerateMembers(IMemberVisitor visitor)
Overrides:
enumerateMembers in class Table