com.crystaldecisions.sdk.occa.report.document
Class DataDocument

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.document.DataDocument
All Implemented Interfaces:
IDataDocument, IDocument, IClone
Direct Known Subclasses:
ReportDocument

public class DataDocument
extends java.lang.Object
implements IDataDocument, IClone

This object enables you to get and set information about the document's data source.


Constructor Summary
DataDocument()
           
DataDocument(IDataDocument 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, com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt, java.util.Map objState, boolean[] bLoaded)
           For internal use only.
 void doControllerModification(java.lang.Object newObject)
           
 void endElement(java.lang.String eleName, java.util.Map objState)
           For internal use only.
 void enumerateMembers(IMemberVisitor visitor)
           
 ControllableMixin getControllableMixin()
           
 IDatabase getDatabase()
          Returns the database object.
 IDataDefinition getDataDefinition()
          Returns the DataDefinition.
 java.lang.String getName()
          Returns the name of the report document as a String.
 int getOptions()
          Returns the options that are set for the report document.
 java.lang.String getRemoteID()
          For internal use only.
 java.util.Date getTimestamp()
          Returns the time stamp.
 PropertyBag getUID()
          Returns the UID, which are properties that uniquely identify the directory item.
 boolean hasContent(java.lang.Object obj)
           
 boolean isDirectlyControllable()
           
 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(com.crystaldecisions.xml.serialization.XMLWriter writer, com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
           For internal use only.
 void save(com.crystaldecisions.xml.serialization.XMLWriter writer, java.lang.String sTag, com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
           For internal use only.
 void saveContents(XMLWriter writer, XMLSerializationContext ctxt)
           For internal use only.
 void setDatabase(IDatabase database)
          Sets the database object.
 void setDataDefinition(IDataDefinition dataDefinition)
          Sets the DataDefinition.
 void setName(java.lang.String name)
          Sets the name of the report document as a String.
 void setOptions(int options)
          Sets the options for the report document.
 void setRemoteID(java.lang.String remoteID)
          For internal use only.
 void setTimestamp(java.util.Date newTimestamp)
          Sets the time stamp.
 void setUID(PropertyBag uID)
          Sets the UID, which are properties that uniquely identify the directory item.
 void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
           For internal use only.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DataDocument

public DataDocument(IDataDocument src)

DataDocument

public DataDocument()
Method Detail

clone

public java.lang.Object clone(boolean deepClone)

copyTo

public void copyTo(java.lang.Object destObject,
                   boolean deepCopy)

createMember

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

For internal use only.


endElement

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

For internal use only.


getDatabase

public IDatabase getDatabase()
Description copied from interface: IDataDocument

Returns the database object. This object contains the tables and fields available in the report. To modify any database property, you must use the methods in the DatabaseController. These methods also allow you to add and remove tables or fields.

Specified by:
getDatabase in interface IDataDocument
Returns:
The database object as a com.crystaldecisions.ras.datamodel.IDatabase object.

getDataDefinition

public IDataDefinition getDataDefinition()
Description copied from interface: IDataDocument

Returns the DataDefinition. Returns an object containing formulas, filters, groups, parameters, sort objects, and summaries. The DataDefinition contains all the data structures necessary to define and manipulate the data that the report contains. Note that the report's data definition is not concerned with how the report is laid out. That is, it does not store information regarding graphics, charts, borders, or text objects. Although the DataDefinition represents the data in a report, it does not synchronize the data that your Report Application Server client is manipulating with that on the server. In order to properly modify the report, you must use the appropriate controller.

Specified by:
getDataDefinition in interface IDataDocument
Returns:
The com.crystaldecisions.sdk.occa.report.data.IDataDefinition object.

getName

public java.lang.String getName()
Description copied from interface: IDocument

Returns the name of the report document as a String.

Specified by:
getName in interface IDocument
Returns:
The name of the report document as a String. If no name was supplied, the name is the document's file name without path information or an extension.

getOptions

public int getOptions()
Description copied from interface: IDocument

Returns the options that are set for the report document.

Specified by:
getOptions in interface IDocument
Returns:
The options that are set for the report document as an int.

getRemoteID

public java.lang.String getRemoteID()
Description copied from interface: IDocument

For internal use only.

Specified by:
getRemoteID in interface IDocument

getTimestamp

public java.util.Date getTimestamp()
Description copied from interface: IDocument

Returns the time stamp.

Specified by:
getTimestamp in interface IDocument
Returns:
The time stamp for the document. This is represented by the milliseconds since January 1, 1970, 00:00:00 GMT.

getUID

public PropertyBag getUID()
Description copied from interface: IDocument

Returns the UID, which are properties that uniquely identify the directory item. Use the properties in the returned property bag to help identify the directory item. For example, you can retrieve a report's name or a connection's location from the property bag and display it in the ConnectionDirManager tree structure.

Specified by:
getUID in interface IDocument
Returns:
The PropertyBag.

hasContent

public boolean hasContent(java.lang.Object obj)

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.


save

public void save(com.crystaldecisions.xml.serialization.XMLWriter writer,
                 com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt)
          throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

save

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

For internal use only.

Throws:
java.io.IOException

saveContents

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

For internal use only.

Throws:
java.io.IOException

setDatabase

public void setDatabase(IDatabase database)
Description copied from interface: IDataDocument

Sets the database object. This object contains the tables and fields available in the report. To modify any database property, you must use the methods in the DatabaseController. These methods also allow you to add and remove tables or fields.

Specified by:
setDatabase in interface IDataDocument
Parameters:
database - The database as a com.crystaldecisions.sdk.occa.report.data.IDatabase object.

setDataDefinition

public void setDataDefinition(IDataDefinition dataDefinition)
Description copied from interface: IDataDocument

Sets the DataDefinition. Returns an object containing formulas, filters, groups, parameters, sort objects, and summaries. The DataDefinition contains all the data structures necessary to define and manipulate the data that the report contains. Note that the report's data definition is not concerned with how the report is laid out. That is, it does not store information regarding graphics, charts, borders, or text objects. Although the DataDefinition represents the data in a report, it does not synchronize the data that your Report Application Server client is manipulating with that on the server. In order to properly modify the report, you must use the appropriate controller.

Specified by:
setDataDefinition in interface IDataDocument
Parameters:
dataDefinition - The com.crystaldecisions.sdk.occa.report.data.IDataDefinition object.

setName

public void setName(java.lang.String name)
Description copied from interface: IDocument

Sets the name of the report document as a String. If no name is supplied, the name is the document's file name without path information or an extension.

Specified by:
setName in interface IDocument
Parameters:
name - The name of the report document as a String.

setOptions

public void setOptions(int options)
Description copied from interface: IDocument

Sets the options for the report document. Refer to DocumentOptions for field values.

Specified by:
setOptions in interface IDocument
Parameters:
options - The options that are set for the report document as an int.

setRemoteID

public void setRemoteID(java.lang.String remoteID)
Description copied from interface: IDocument

For internal use only.

Specified by:
setRemoteID in interface IDocument

setTimestamp

public void setTimestamp(java.util.Date newTimestamp)
Description copied from interface: IDocument

Sets the time stamp.

Specified by:
setTimestamp in interface IDocument
Parameters:
newTimestamp - The time stamp for the document. This is represented by the milliseconds since January 1, 1970, 00:00:00 GMT.

setUID

public void setUID(PropertyBag uID)
Description copied from interface: IDocument

Sets the UID, which are properties that uniquely identify the directory item. Use the properties in the returned property bag to help identify the directory item. For example, you can retrieve a report's name or a connection's location from the property bag and display it in the ConnectionDirManager tree structure.

Specified by:
setUID in interface IDocument
Parameters:
uID - The PropertyBag.

startElement

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

For internal use only.


getControllableMixin

public ControllableMixin getControllableMixin()

doControllerModification

public void doControllerModification(java.lang.Object newObject)

isDirectlyControllable

public boolean isDirectlyControllable()

enumerateMembers

public void enumerateMembers(IMemberVisitor visitor)