* Assumes a base JAXB project context structure * corresponding to the JAXB spec: *
* RootContext * |- persistence.xml * |- persistence unit(s) * |- mapping file(s) (e.g. orm.xml) * | |- persistent type mapping(s) (e.g. Entity) * | |- persistent attribute mapping(s) (e.g. Basic) * |- persistent type mapping(s) ** ... and associated objects. *
* Provisional API: This interface is part of an interim API that is still * under development and expected to change significantly before reaching * stability. It is available at this early stage to solicit feedback from * pioneering adopters on the understanding that any code that uses this API * will almost certainly be broken (repeatedly) as the API evolves. * * @see org.eclipse.jpt.jaxb.core.internal.jaxb21.GenericJaxb_2_1_Factory * * @version 3.0 * @since 3.0 */ public interface JaxbFactory { // ********** Core Model ********** /** * Construct a JaxbProject for the specified config, to be * added to the specified JAXB project. Return null if unable to create * the JAXB file (e.g. the content type is unrecognized). */ JaxbProject buildJaxbProject(JaxbProject.Config config); /** * Construct a JAXB file for the specified JAXB project, file, content type, * and resource model. */ JaxbFile buildJaxbFile(JaxbProject jaxbProject, IFile file, IContentType contentType, JptResourceModel resourceModel); // ********** Non-resource-specific context nodes ********** /** * Build a (/an updated) root context node to be associated with the given * JAXB project. * The root context node will be built once, but updated many times. * @see JaxbProject#update(org.eclipse.core.runtime.IProgressMonitor) */ JaxbContextRoot buildContextRoot(JaxbProject jaxbProject); JaxbPackage buildPackage(JaxbContextRoot parent, String packageName); // ********** Java context nodes ********** JaxbPackageInfo buildJavaPackageInfo(JaxbPackage parent, JavaResourcePackage resourcePackage); JaxbRegistry buildRegistry(JaxbContextRoot parent, JavaResourceType resourceType); JaxbTransientClass buildJavaTransientClass(JaxbContextRoot parent, JavaResourceType resourceType); JaxbPersistentClass buildJavaPersistentClass(JaxbContextRoot parent, JavaResourceType resourceType); JaxbPersistentEnum buildJavaPersistentEnum(JaxbContextRoot parent, JavaResourceEnum resourceEnum); XmlSchema buildJavaXmlSchema(JaxbPackageInfo parent); XmlNs buildJavaXmlNs(XmlSchema parent, XmlNsAnnotation xmlNsAnnotation); XmlRootElement buildJavaXmlRootElement(JaxbPersistentType parent, XmlRootElementAnnotation xmlRootElementAnnotation); JaxbEnumConstant buildJavaEnumConstant(JaxbPersistentEnum parent, JavaResourceEnumConstant resourceEnumConstant); JaxbElementFactoryMethod buildJavaElementFactoryMethod(JaxbRegistry parent, JavaResourceMethod resourceMethod); JaxbPersistentField buildJavaPersistentField(JaxbPersistentClass parent, JavaResourceField resourceField); JaxbPersistentProperty buildJavaPersistentProperty(JaxbPersistentClass parent, JavaResourceMethod resourceGetter, JavaResourceMethod resourceSetter); JaxbAttributeMapping buildJavaNullAttributeMapping(JaxbPersistentAttribute parent); XmlAnyAttributeMapping buildJavaXmlAnyAttributeMapping(JaxbPersistentAttribute parent); XmlAnyElementMapping buildJavaXmlAnyElementMapping(JaxbPersistentAttribute parent); XmlAttributeMapping buildJavaXmlAttributeMapping(JaxbPersistentAttribute parent); XmlElementMapping buildJavaXmlElementMapping(JaxbPersistentAttribute parent); JaxbAttributeMapping buildJavaXmlTransientMapping(JaxbPersistentAttribute parent); XmlValueMapping buildJavaXmlValueMapping(JaxbPersistentAttribute parent); }