com.reportmill.datasource
Class RMEntity

java.lang.Object
  com.reportmill.datasource.RMEntity

public class RMEntity
extends java.lang.Object

This class represents an entity for an RMDataSource. It has a list of RMProperties, some of which are simple attributes and some of which are relationships.

Field Summary

java.util.List	_attributes
java.util.List	_attributesSorted
java.lang.String	_name
java.util.List	_primaries
java.util.List	_properties
java.util.List	_relations
java.util.List	_relationsSorted
RMSchema	_schema

Constructor Summary

RMEntity()
Creates an empty entity.

RMEntity(java.lang.String name)
Creates an entity with the given name.

Method Summary

void	addProperty(RMProperty aProperty) Adds a given property.
java.lang.Object	clone() Standard clone implementation.
boolean	equals(java.lang.Object obj) Standard equals method.
java.lang.Object	fromXML(com.reportmill.archiver.RXArchiver anArchiver, com.reportmill.archiver.RXElement anElement) XML unarchival.
RMProperty	getAttribute(int anIndex) Returns the attribute at the given index.
RMProperty	getAttribute(java.lang.String aName) Returns the attribute with the given name.
int	getAttributeCount() Returns the number of attributes.
RMProperty	getAttributeSorted(int anIndex) Returns the attribute at the given index in a sorted attributes list.
RMEntity	getEntity(java.lang.String aKeyPath) Returns the child entity for the key path evaluated from this entity.
java.lang.String	getName() Returns the name of the entity.
RMProperty	getPrimary(int anIndex) Returns the primary attribute at the given index.
int	getPrimaryCount() Returns the number of primary attributes for this entity.
RMProperty	getProperty(int anIndex) Returns the property at the given index.
RMProperty	getProperty(java.lang.String aName) Returns the property with the given name.
int	getPropertyCount() Returns the number of properties.
int	getPropertyIndex(java.lang.String aName) Returns the property with the given name.
RMProperty	getRelation(int anIndex) Returns the relation at the given index.
RMProperty	getRelation(java.lang.String aKeyPath) Returns the relation for the given key path.
int	getRelationCount() Returns the number of relations in the enity.
RMProperty	getRelationSorted(int anIndex) Returns the relation at the given index in the sorted list of relations.
RMSchema	getSchema() Returns the top level entity which is the schema.
void	removeProperty(java.lang.String name) Removes a given property.
void	setName(java.lang.String aName) Sets the name of the entity.
java.lang.String	toString() Returns a string representation of entity (its 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

Field Detail

_name

public java.lang.String _name

_schema

public RMSchema _schema

_properties

public java.util.List _properties

_attributes

public java.util.List _attributes

_relations

public java.util.List _relations

_attributesSorted

public java.util.List _attributesSorted

_relationsSorted

public java.util.List _relationsSorted

_primaries

public java.util.List _primaries

Constructor Detail

RMEntity

public RMEntity()

Creates an empty entity.

RMEntity

public RMEntity(java.lang.String name)

Creates an entity with the given name.

Method Detail

getName

public java.lang.String getName()

Returns the name of the entity.

setName

public void setName(java.lang.String aName)

Sets the name of the entity.

getSchema

public RMSchema getSchema()

Returns the top level entity which is the schema.

getPropertyCount

public int getPropertyCount()

Returns the number of properties.

getProperty

public RMProperty getProperty(int anIndex)

Returns the property at the given index.

getProperty

public RMProperty getProperty(java.lang.String aName)

Returns the property with the given name.

getPropertyIndex

public int getPropertyIndex(java.lang.String aName)

Returns the property with the given name.

addProperty

public void addProperty(RMProperty aProperty)

Adds a given property.

removeProperty

public void removeProperty(java.lang.String name)

Removes a given property.

getAttributeCount

public int getAttributeCount()

Returns the number of attributes.

getAttribute

public RMProperty getAttribute(int anIndex)

Returns the attribute at the given index.

getAttribute

public RMProperty getAttribute(java.lang.String aName)

Returns the attribute with the given name.

getAttributeSorted

public RMProperty getAttributeSorted(int anIndex)

Returns the attribute at the given index in a sorted attributes list.

getRelationCount

public int getRelationCount()

Returns the number of relations in the enity.

getRelation

public RMProperty getRelation(int anIndex)

Returns the relation at the given index.

getRelation

public RMProperty getRelation(java.lang.String aKeyPath)

Returns the relation for the given key path.

getRelationSorted

public RMProperty getRelationSorted(int anIndex)

Returns the relation at the given index in the sorted list of relations.

getEntity

public RMEntity getEntity(java.lang.String aKeyPath)

Returns the child entity for the key path evaluated from this entity.

getPrimaryCount

public int getPrimaryCount()

Returns the number of primary attributes for this entity.

getPrimary

public RMProperty getPrimary(int anIndex)

Returns the primary attribute at the given index.

equals

public boolean equals(java.lang.Object obj)

Standard equals method.

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Returns a string representation of entity (its name).

Overrides:

toString in class java.lang.Object

clone

public java.lang.Object clone()

Standard clone implementation.

Overrides:

clone 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.