com.reportmill.datasource
Class RMSchema

java.lang.Object
  com.reportmill.datasource.RMSchema

All Implemented Interfaces:

java.lang.Cloneable

public class RMSchema
extends java.lang.Object
implements java.lang.Cloneable

This class describes the structure of a datasource by managing a list of RMEntity.

Constructor Summary

RMSchema()
Creates a new empty schema.

RMSchema(java.lang.String aName)
Creates a new schema with the given name.

Method Summary

void	addEntity(RMEntity anEntity) Adds an entity to the list.
java.lang.Object	clone() Standard clone implementation.
boolean	equals(java.lang.Object anObj) Standard equals implementation.
java.lang.Object	fromXML(com.reportmill.archiver.RXArchiver anArchiver, com.reportmill.archiver.RXElement anElement) XML unarchival.
RMEntity	getEntity(int anIndex) Returns the specific entity at the given index.
RMEntity	getEntity(java.lang.String aName) Returns the schema entity with the given name.
int	getEntityCount() Returns the number of entities in this schema.
RMEntity	getRootEntity() Returns the root entity.
java.lang.String	getRootEntityName() Returns the schema's root entity name.
void	removeEntity(RMEntity anEntity) Removes an entity from the list.
void	setRootEntityName(java.lang.String aName) Sets the schema's root entity name.
java.lang.String	toString() Returns schema name.
com.reportmill.archiver.RXElement	toXML(com.reportmill.archiver.RXArchiver anArchiver) XML archival.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RMSchema

public RMSchema()

Creates a new empty schema.

RMSchema

public RMSchema(java.lang.String aName)

Creates a new schema with the given name.

Method Detail

getEntityCount

public int getEntityCount()

Returns the number of entities in this schema.

getEntity

public RMEntity getEntity(int anIndex)

Returns the specific entity at the given index.

addEntity

public void addEntity(RMEntity anEntity)

Adds an entity to the list.

removeEntity

public void removeEntity(RMEntity anEntity)

Removes an entity from the list.

getEntity

public RMEntity getEntity(java.lang.String aName)

Returns the schema entity with the given name.

getRootEntityName

public java.lang.String getRootEntityName()

Returns the schema's root entity name.

setRootEntityName

public void setRootEntityName(java.lang.String aName)

Sets the schema's root entity name.

getRootEntity

public RMEntity getRootEntity()

Returns the root entity.

equals

public boolean equals(java.lang.Object anObj)

Standard equals implementation.

Overrides:

equals in class java.lang.Object

clone

public java.lang.Object clone()

Standard clone implementation.

Overrides:

clone in class java.lang.Object

toString

public java.lang.String toString()

Returns schema name.

Overrides:

toString in class java.lang.Object

toXML

public com.reportmill.archiver.RXElement toXML(com.reportmill.archiver.RXArchiver anArchiver)

XML archival.

fromXML

public java.lang.Object fromXML(com.reportmill.archiver.RXArchiver anArchiver,
                                com.reportmill.archiver.RXElement anElement)

XML unarchival.