org.objectweb.medor.query.jorm.api
Interface JormExtent

All Superinterfaces:
java.lang.Cloneable, QueryLeaf, QueryTree
All Known Implementing Classes:
BasicJormExtent

public interface JormExtent
extends QueryLeaf

This class represent a a jorm query leaf.

Author:
S.Chassande-Barrioz

Method Summary
 JormField getIdentifierField()
           
 java.lang.String getJormName()
           
 MetaObject getMetaObject()
           
 PMapper getPMapper()
           
 java.lang.String getPNameFieldName()
           
 java.lang.String getProjectName()
           
 void setDataStore(DataStore ds)
           
 void setPMapper(PMapper m, java.lang.String projectName)
           
 void setProjectName(java.lang.String projectName)
           
 void setWithSubClasses(boolean includeSubClasses)
          Indicates whether the current Extent should also contain objects from the subclasses.
 boolean withSubClasses()
          Tells whether the current Extent should also contain objects from the subclasses.
 
Methods inherited from interface org.objectweb.medor.query.api.QueryLeaf
getDataStore
 
Methods inherited from interface org.objectweb.medor.query.api.QueryTree
getDistinct, getName, getOrderBy, getTupleStructure, setDistinct, setOrderBy
 

Method Detail

getPMapper

public PMapper getPMapper()

setPMapper

public void setPMapper(PMapper m,
                       java.lang.String projectName)

getProjectName

public java.lang.String getProjectName()

setProjectName

public void setProjectName(java.lang.String projectName)

getPNameFieldName

public java.lang.String getPNameFieldName()

setDataStore

public void setDataStore(DataStore ds)

getJormName

public java.lang.String getJormName()

getIdentifierField

public JormField getIdentifierField()

getMetaObject

public MetaObject getMetaObject()

withSubClasses

public boolean withSubClasses()
Tells whether the current Extent should also contain objects from the subclasses.

The default is that only objects strictly in the current class are included, and not objects of the subclasses.

Returns:
true if objects from subclasses are to be included, false if only strict instances of the corresponding class should be included.

setWithSubClasses

public void setWithSubClasses(boolean includeSubClasses)
Indicates whether the current Extent should also contain objects from the subclasses.

The default is that only objects strictly in the current class are included, and not objects of the subclasses.

Parameters:
includeSubClasses - is true if objects from subclasses are to be included, false if only strict instances of the corresponding class should be included.