Package org.apache.openjpa.lib.identifier

Interface IdentifierConfiguration

  • public interface IdentifierConfiguration
    The IdentifierConfiguration interface. Implementers of this interface supply naming configuration information to consumers of names/identifiers.

    • Method Detail

      • getLeadingDelimiter

        String getLeadingDelimiter()
        Returns the leading delimiter value to use when delimiting a name.

      • getTrailingDelimiter

        String getTrailingDelimiter()
        Returns the trailing delimiter value to use when delimiting a name.

      • delimitAll

        boolean delimitAll()
        Returns true if global name delimiting is enabled.

      • getSupportsDelimitedIdentifiers

        boolean getSupportsDelimitedIdentifiers()
        Returns true if delimiting is supported

      • getIdentifierConcatenator

        String getIdentifierConcatenator()
        Returns the value used to concatenate multiple names together. For example: "_" used in TABLE1_TABLE2

      • getIdentifierDelimiter

        String getIdentifierDelimiter()
        Returns the value used to delimit between individual names. For example: "." used in MYSCHEMA.MYTABLE

      • getDefaultIdentifierRule

        IdentifierRule getDefaultIdentifierRule()
        Gets the default naming rule

      • getIdentifierRules

        <T> Map<T,​IdentifierRule> getIdentifierRules()
        Returns all naming rules

      • getIdentifierRule

        <T> IdentifierRule getIdentifierRule​(T t)
        Returns a naming rule or null if the rule is not found.

      • getDelimitedCase

        String getDelimitedCase()
        Returns the case that is used when delimiting.
        Returns:
        upper, lower, or preserve

      • getSchemaCase

        String getSchemaCase()
        Returns the case that is used when delimiters are not used.
        Returns:
        upper, lower, or preserve

      • getConversionKey

        String getConversionKey()
        Returns a key that can be used to determine whether conversion should take place. Id configurations should create a key unique to their configuration. The typical key is: leading delimiter (") + name separator(.) + trailing delimiter(")