Java Doc for DatastoreClass.java in » Database-ORM » JPOX » org » jpox » store » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Database ORM » JPOX » org.jpox.store

Source Cross Reference

Class Diagram

Java Document (Java Doc)

org.jpox.store .DatastoreClass

DatastoreClass
public interface DatastoreClass extends DatastoreContainerObject(Code)
	Representation of a Java class in a datastore. In the case of RDBMS this will be a table (primary or secondary). In the case of a file-based structure this may be a directory. In the case of an XML-based structure this may be an element. version: $Revision: 1.37 $

Method Summary
void	delete(StateManager sm) Method to delete an object for this class.
void	fetch(StateManager sm, AbstractMemberMetaData[] fieldMetaData) Method to fetch an object for this class.
public DatastoreClass	getBaseDatastoreClassWithField(AbstractMemberMetaData fmd) Method to return the base DatastoreClass that persists the specified field.
JavaTypeMapping	getDataStoreObjectIdMapping() Accessor for a mapping for the datastore ID (OID) for this object.
JavaTypeMapping	getExternalMapping(AbstractMemberMetaData fmd, int mappingType) Accessor for the external mapping for the specified field of the specified type.
JavaTypeMapping	getFieldMapping(String fieldName) Accessor for the mapping for the specified field name.
JavaTypeMapping	getFieldMapping(AbstractMemberMetaData mmd) Accessor for the mapping for the specified field.
JavaTypeMapping	getFieldMappingInDatastoreClass(AbstractMemberMetaData mmd) Accessor for the mapping for the specified field only in this datastore class.
public IdentityType	getIdentityType() Accessor for the identity-type used by this table.
AbstractMemberMetaData	getMetaDataForExternalMapping(JavaTypeMapping mapping, int mappingType)
public DatastoreClass	getSuperDatastoreClass() Accessor for the supertable for this table.
String	getType() Accessor for the primary class represented.
void	insert(StateManager sm) Method to insert an object for this class.
boolean	isBaseDatastoreClass() Accessor for whether this datastore class is the base datastore class for this inheritance hierarchy.
boolean	isObjectIDDatastoreAttributed() Accessor for whether the object id will be attributed by the datastore directly, or whether values have to be supplied.
void	locate(StateManager sm) Locates this object in the datastore.
public boolean	managesClass(String className)
void	provideDatastoreIdMappings(MappingConsumer consumer) Accessor for a mapping for the datastore ID (OID) for this table.
void	provideDiscriminatorMappings(MappingConsumer consumer)
void	provideExternalMappings(MappingConsumer consumer, int mappingType) Instruction to provide all external mappings to the passed consumer.
void	provideMappingsForFields(MappingConsumer consumer, AbstractMemberMetaData[] fieldMetaData, boolean includeSecondaryTables) Provide the mappings to the consumer for all absolute field Numbers in this table that are container in the fieldNumbers parameter.
void	provideNonPrimaryKeyMappings(MappingConsumer consumer) Provide the mappings to the consumer for all non primary-key fields mapped to this table.
void	providePrimaryKeyMappings(MappingConsumer consumer) Provide the mappings to the consumer for all primary-key fields mapped to this table (for application identity).
void	provideUnmappedDatastoreFields(MappingConsumer consumer) Instruction to provide all datastore fields without mappings.
void	provideVersionMappings(MappingConsumer consumer)
String	toString() Accessor for the name of the datastore class (table).
void	update(StateManager sm, AbstractMemberMetaData[] fieldMetaData) Method to update an object for this class.

Method Detail

delete
void delete(StateManager sm)(Code)
	Method to delete an object for this class. Will delete any superclass records as well (recursive). Parameters: sm - StateManager for the object to delete.

fetch
void fetch(StateManager sm, AbstractMemberMetaData[] fieldMetaData)(Code)
	Method to fetch an object for this class. Will fetch any superclass records as well (recursive). Parameters: sm - StateManager for the object to fetch. Parameters: fieldMetaData - MetaData for the fields to be fetched

getBaseDatastoreClassWithField
public DatastoreClass getBaseDatastoreClassWithField(AbstractMemberMetaData fmd)(Code)
	Method to return the base DatastoreClass that persists the specified field. This navigates up through the superclass tables to find a table that manages the field. Parameters: fmd - MetaData for the field required The DatastoreClass managing that field

getDataStoreObjectIdMapping
JavaTypeMapping getDataStoreObjectIdMapping()(Code)
	Accessor for a mapping for the datastore ID (OID) for this object. The (OID) mapping.

getExternalMapping
JavaTypeMapping getExternalMapping(AbstractMemberMetaData fmd, int mappingType)(Code)
	Accessor for the external mapping for the specified field of the specified type. An external mapping is a mapping for which there is no field in the actual class to represent it (part of a relation). The type can be FK, FK discriminator, order, etc Parameters: fmd - MetaData for the (external) field Parameters: mappingType - The type of mapping The external mapping

getFieldMapping
JavaTypeMapping getFieldMapping(String fieldName)(Code)
	Accessor for the mapping for the specified field name. Doesn't cope with fields of the same name in different subclasses - you should call the equivalent method passing FieldMetaData for those. Parameters: fieldName - Name of field The Mapping for the field.

getFieldMapping
JavaTypeMapping getFieldMapping(AbstractMemberMetaData mmd)(Code)
	Accessor for the mapping for the specified field. Parameters: mmd - Metadata of the field/property The Mapping for the field.

getFieldMappingInDatastoreClass
JavaTypeMapping getFieldMappingInDatastoreClass(AbstractMemberMetaData mmd)(Code)
	Accessor for the mapping for the specified field only in this datastore class. Parameters: mmd - Metadata of the field/property The Mapping for the field (or null if not present here)

getIdentityType
public IdentityType getIdentityType()(Code)
	Accessor for the identity-type used by this table. identity-type tag value

getMetaDataForExternalMapping
AbstractMemberMetaData getMetaDataForExternalMapping(JavaTypeMapping mapping, int mappingType)(Code)
	Accessor for the owner field metadata for the specified external mapping of the specified type Parameters: mapping - The external mapping Parameters: mappingType - The type of mapping Field MetaData in the owner class

getSuperDatastoreClass
public DatastoreClass getSuperDatastoreClass()(Code)
	Accessor for the supertable for this table. This is only relevant if the DatastoreClass in use supports supertables. If supertables arent supported by the datastore then null is returned. The supertable (if any)

getType
String getType()(Code)
	Accessor for the primary class represented. Name of the class

insert
void insert(StateManager sm)(Code)
	Method to insert an object for this class. Will insert any superclass records as well (recursive). Parameters: sm - StateManager for the object to insert.

isBaseDatastoreClass
boolean isBaseDatastoreClass()(Code)
	Accessor for whether this datastore class is the base datastore class for this inheritance hierarchy. Whether it is the base.

isObjectIDDatastoreAttributed
boolean isObjectIDDatastoreAttributed()(Code)
	Accessor for whether the object id will be attributed by the datastore directly, or whether values have to be supplied. Whether it is attributed in the datastore

locate
void locate(StateManager sm)(Code)
	Locates this object in the datastore. Parameters: sm - The StateManager for the object to be found throws: JPOXObjectNotFoundException - If the instance does not exist in the datastore

managesClass
public boolean managesClass(String className)(Code)
	Accessor for whether this table manages the specified class Parameters: className - Name of the class Whether it is managed by this table

provideDatastoreIdMappings
void provideDatastoreIdMappings(MappingConsumer consumer)(Code)
	Accessor for a mapping for the datastore ID (OID) for this table. Parameters: consumer - Consumer for the mappings

provideDiscriminatorMappings
void provideDiscriminatorMappings(MappingConsumer consumer)(Code)
	Provide the mappings to discriminator mappings Parameters: consumer - Consumer for the mappings

provideExternalMappings
void provideExternalMappings(MappingConsumer consumer, int mappingType)(Code)
	Instruction to provide all external mappings to the passed consumer. Parameters: consumer - The consumer for the mappings Parameters: mappingType - Type of external mapping to provide

provideMappingsForFields
void provideMappingsForFields(MappingConsumer consumer, AbstractMemberMetaData[] fieldMetaData, boolean includeSecondaryTables)(Code)
	Provide the mappings to the consumer for all absolute field Numbers in this table that are container in the fieldNumbers parameter. Parameters: consumer - Consumer for the mappings Parameters: fieldMetaData - MetaData of the fields to provide mappings for Parameters: includeSecondaryTables - Whether to supply fields in secondary tables

provideNonPrimaryKeyMappings
void provideNonPrimaryKeyMappings(MappingConsumer consumer)(Code)
	Provide the mappings to the consumer for all non primary-key fields mapped to this table. Parameters: consumer - Consumer for the mappings

providePrimaryKeyMappings
void providePrimaryKeyMappings(MappingConsumer consumer)(Code)
	Provide the mappings to the consumer for all primary-key fields mapped to this table (for application identity). Parameters: consumer - Consumer for the mappings

provideUnmappedDatastoreFields
void provideUnmappedDatastoreFields(MappingConsumer consumer)(Code)
	Instruction to provide all datastore fields without mappings. Parameters: consumer - The consumer for the datastore fields

provideVersionMappings
void provideVersionMappings(MappingConsumer consumer)(Code)
	Provide the mappings to version mappings Parameters: consumer - Consumer for the version mappings

toString
String toString()(Code)
	Accessor for the name of the datastore class (table). The name

update
void update(StateManager sm, AbstractMemberMetaData[] fieldMetaData)(Code)
	Method to update an object for this class. Will update any superclass records as well (recursive). Parameters: sm - StateManager for the object to update. Parameters: fieldMetaData - MetaData for the fields to be updated

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.