Package org.apache.openjpa.meta

Class AbstractCFMetaDataFactory

    • Field Detail

      • files

        protected java.util.Collection<java.io.File> files

      • urls

        protected java.util.Collection<java.net.URL> urls

      • rsrcs

        protected java.util.Collection<java.lang.String> rsrcs

      • cpath

        protected java.util.Collection<java.lang.String> cpath

      • PERSISTENCE_UNIT_ROOT_URL

        public static final java.lang.String PERSISTENCE_UNIT_ROOT_URL
        See Also:
        Constant Field Values

      • MAPPING_FILE_NAMES

        public static final java.lang.String MAPPING_FILE_NAMES
        See Also:
        Constant Field Values

    • Constructor Detail

      • AbstractCFMetaDataFactory

        public AbstractCFMetaDataFactory()

    • Method Detail

      • setFiles

        public void setFiles​(java.util.Collection<java.io.File> files)
        Set of Files of metadata files or directories supplied by user.

      • setFiles

        public void setFiles​(java.lang.String files)
        Set of semicolon-separated Files of metadata files or directories supplied by user via auto-configuration.

      • setURLs

        public void setURLs​(java.util.Collection<java.net.URL> urls)
        Set of URLs of metadata files or jars supplied by user.

      • setURLs

        public void setURLs​(java.lang.String urls)
        Set of semicolon-separated URLs of metadata files or jars supplied by user via auto-configuration.

      • setResources

        public void setResources​(java.util.Collection<java.lang.String> rsrcs)
        Set of resource paths of metadata files or jars supplied by user.

      • setResources

        public void setResources​(java.lang.String rsrcs)
        Set of semicolon-separated resource paths of metadata files or jars supplied by user via auto-configuration.

      • setClasspathScan

        public void setClasspathScan​(java.util.Collection<java.lang.String> cpath)
        Set of classpath directories or jars to scan for metadata supplied by user.

      • setClasspathScan

        public void setClasspathScan​(java.lang.String cpath)
        Set of classpath directories or jars to scan for metadata supplied by user via auto-configuration.

      • store

        public boolean store​(ClassMetaData[] metas,
                     QueryMetaData[] queries,
                     SequenceMetaData[] seqs,
                     int mode,
                     java.util.Map<java.io.File,​java.lang.String> output)
        Description copied from interface: MetaDataFactory
        Store the given metadata.
        Specified by:
        store in interface MetaDataFactory
        Overrides:
        store in class AbstractMetaDataFactory
        mode - hint about what aspects of the metadata have changed
        output - if non-null, rather than storing metadata directly, add entries mapping each output destination such as a File to the planned output for that destination in string form
        Returns:
        false if this factory is unable to store metadata

      • drop

        public boolean drop​(java.lang.Class[] cls,
                    int mode,
                    java.lang.ClassLoader envLoader)
        Description copied from interface: MetaDataFactory
        Drop the metadata for the given classes in the given mode(s).
        Specified by:
        drop in interface MetaDataFactory
        Overrides:
        drop in class AbstractMetaDataFactory
        Returns:
        false if any metadata could not be dropped

      • isMappingOnlyFactory

        protected boolean isMappingOnlyFactory()
        Return true if this factory deals only with mapping data, and relies on a separate factory for metadata.

      • parse

        protected void parse​(MetaDataParser parser,
                     java.util.Collection files)
        Parse all given files.

      • parse

        protected void parse​(MetaDataParser parser,
                     java.lang.Class[] cls)
        Parse all given classses.

      • isParseTopDown

        protected boolean isParseTopDown()
        Whether to parse classes top down. Defaults to false.

      • serialize

        protected void serialize​(MetaDataSerializer ser,
                         java.util.Map<java.io.File,​java.lang.String> output,
                         int flags)
        Tell the given serialier to write its metadatas.

      • backupAndDelete

        protected void backupAndDelete​(java.util.Collection files)
        Backup and delete the source files for the given metadatas.

      • clearMapping

        protected void clearMapping​(ClassMetaData meta)
        Clear mapping information from the given metadata.

      • getSourceFile

        protected java.io.File getSourceFile​(ClassMetaData meta)
        Return the current source file of the given metadata.

      • setSourceFile

        protected void setSourceFile​(ClassMetaData meta,
                             java.io.File sourceFile)
        Set the current source file of the given metadata.

      • getSourceFile

        protected java.io.File getSourceFile​(SequenceMetaData meta)
        Return the current source file of the given metadata.

      • setSourceFile

        protected void setSourceFile​(SequenceMetaData meta,
                             java.io.File sourceFile)
        Set the current source file of the given metadata.

      • defaultSourceFile

        protected abstract java.io.File defaultSourceFile​(ClassMetaData meta)
        Return the default file for the given metadata.

      • defaultSourceFile

        protected abstract java.io.File defaultSourceFile​(QueryMetaData query,
                                                  java.util.Map clsNames)
        Return a default file for the given query.

      • defaultSourceFile

        protected abstract java.io.File defaultSourceFile​(SequenceMetaData seq,
                                                  java.util.Map clsNames)
        Return a default file for the given sequence.

      • newParser

        protected abstract AbstractCFMetaDataFactory.Parser newParser​(boolean loading)
        Create a new metadata parser.
        Parameters:
        loading - if true, this will be the cached parser used for loading metadata

      • getDefiningMetaData

        protected ClassMetaData getDefiningMetaData​(QueryMetaData query,
                                            java.util.Map clsNames)
        Return the metadata that defines the given query, if any.
        Parameters:
        clsNames - map of class names to metadatas

      • parsePersistentTypeNames

        protected java.util.Set<java.lang.String> parsePersistentTypeNames​(java.lang.ClassLoader loader)
                                                            throws java.io.IOException
        Parse persistent type names.
        Throws:
        java.io.IOException

      • decode

        public static java.lang.String decode​(java.lang.String s)
        Decodes a URL-encoded path string. For example, an encoded space (%20) is decoded into a normal space (' ') character. Added via OPENJPA-2102.
        Parameters:
        s - - the encoded URL string
        Returns:
        String decoded - the decoded string.

      • mapPersistentTypeNames

        protected void mapPersistentTypeNames​(java.lang.Object rsrc,
                                      java.lang.String[] names)
        Implement this method to map metadata resources to the persistent types contained within them. The method will be called when getPersistentTypeNames(boolean, java.lang.ClassLoader) is invoked.

      • newMetaDataFilter

        protected abstract MetaDataFilter newMetaDataFilter()
        Return a metadata filter that identifies metadata resources when performing jar and classpath scans.