|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.crystaldecisions.sdk.occa.report.document.DataDocument
public class DataDocument
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 |
---|
public DataDocument(IDataDocument src)
public DataDocument()
Method Detail |
---|
public java.lang.Object clone(boolean deepClone)
public void copyTo(java.lang.Object destObject, boolean deepCopy)
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.
public void endElement(java.lang.String eleName, java.util.Map objState)
For internal use only.
public IDatabase getDatabase()
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.
getDatabase
in interface IDataDocument
com.crystaldecisions.ras.datamodel.IDatabase
object.public IDataDefinition getDataDefinition()
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.
getDataDefinition
in interface IDataDocument
com.crystaldecisions.sdk.occa.report.data.IDataDefinition
object.public java.lang.String getName()
IDocument
Returns the name of the report document as a String
.
getName
in interface IDocument
String
.
If no name was supplied, the
name is the document's file name without path information
or an extension.public int getOptions()
IDocument
Returns the options that are set for the report document.
getOptions
in interface IDocument
int
.public java.lang.String getRemoteID()
IDocument
For internal use only.
getRemoteID
in interface IDocument
public java.util.Date getTimestamp()
IDocument
Returns the time stamp.
getTimestamp
in interface IDocument
public PropertyBag getUID()
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.
getUID
in interface IDocument
PropertyBag
.public boolean hasContent(java.lang.Object obj)
public void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
For internal use only.
public void save(com.crystaldecisions.xml.serialization.XMLWriter writer, com.crystaldecisions.xml.serialization.XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
java.io.IOException
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.
java.io.IOException
public void saveContents(XMLWriter writer, XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
java.io.IOException
public void setDatabase(IDatabase database)
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.
setDatabase
in interface IDataDocument
database
- The database as a
com.crystaldecisions.sdk.occa.report.data.IDatabase
object.public void setDataDefinition(IDataDefinition dataDefinition)
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.
setDataDefinition
in interface IDataDocument
dataDefinition
- The com.crystaldecisions.sdk.occa.report.data.IDataDefinition
object.public void setName(java.lang.String name)
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.
setName
in interface IDocument
name
- The name of the report document as a String
.public void setOptions(int options)
IDocument
Sets the options for the report document. Refer to DocumentOptions
for field values.
setOptions
in interface IDocument
options
- The options that are set for the report document as an int
.public void setRemoteID(java.lang.String remoteID)
IDocument
For internal use only.
setRemoteID
in interface IDocument
public void setTimestamp(java.util.Date newTimestamp)
IDocument
Sets the time stamp.
setTimestamp
in interface IDocument
newTimestamp
- The time stamp for the document. This is represented by
the milliseconds since January 1, 1970, 00:00:00 GMT.public void setUID(PropertyBag uID)
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.
setUID
in interface IDocument
uID
- The PropertyBag
.public void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
For internal use only.
public ControllableMixin getControllableMixin()
public void doControllerModification(java.lang.Object newObject)
public boolean isDirectlyControllable()
public void enumerateMembers(IMemberVisitor visitor)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |