Package org.apache.openjpa.lib.identifier

Class IdentifierRule

  • Direct Known Subclasses:
    DBIdentifierRule
    public class IdentifierRule
extends java.lang.Object
    The standard identifier rule. Rules are used for specific configuration of identifier types. For example. A rule could be used to indicate that an identifier type should not be delimited or has a max length of 255 characters.

    • Field Detail

      • EMPTY_SET

        public static final java.util.Set<java.lang.String> EMPTY_SET

      • UNDERSCORE

        public static char UNDERSCORE

    • Constructor Detail

      • IdentifierRule

        public IdentifierRule()

    • Method Detail

      • setName

        public void setName​(java.lang.String name)

      • getName

        public java.lang.String getName()

      • setMaxLength

        public void setMaxLength​(int maxLength)

      • getMaxLength

        public int getMaxLength()

      • setAllowTruncation

        public void setAllowTruncation​(boolean allowTruncation)

      • isAllowTruncation

        public boolean isAllowTruncation()

      • setNullable

        public void setNullable​(boolean nullable)

      • isNullable

        public boolean isNullable()

      • setAllowCompaction

        public void setAllowCompaction​(boolean allowCompaction)

      • getAllowCompaction

        public boolean getAllowCompaction()

      • setCanDelimit

        public void setCanDelimit​(boolean canDelimit)

      • getCanDelimit

        public boolean getCanDelimit()

      • setMustDelimit

        public void setMustDelimit​(boolean mustDelimit)

      • getMustDelimit

        public boolean getMustDelimit()

      • setMustBeginWithLetter

        public void setMustBeginWithLetter​(boolean mustBeginWithLetter)

      • isMustBeginWithLetter

        public boolean isMustBeginWithLetter()

      • setOnlyLettersDigitsUnderscores

        public void setOnlyLettersDigitsUnderscores​(boolean onlyLettersDigitsUnderscores)

      • isOnlyLettersDigitsUnderscores

        public boolean isOnlyLettersDigitsUnderscores()

      • setReservedWords

        public void setReservedWords​(java.util.Set<java.lang.String> reservedWords)

      • getReservedWords

        public java.util.Set<java.lang.String> getReservedWords()

      • setSpecialCharacters

        public void setSpecialCharacters​(java.lang.String specialCharacters)

      • getSpecialCharacters

        public java.lang.String getSpecialCharacters()

      • setDelimitReservedWords

        public void setDelimitReservedWords​(boolean delimitReservedWords)

      • getDelimitReservedWords

        public boolean getDelimitReservedWords()

      • requiresDelimiters

        public boolean requiresDelimiters​(java.lang.String identifier)
        SQL identifier rules: 1) Can be up to 128 characters long 2) Must begin with a letter 3) Can contain letters, digits, and underscores 4) Can't contain spaces or special characters such as #, $, &, %, or punctuation. 5) Can't be reserved words

      • isReservedWord

        public boolean isReservedWord​(java.lang.String identifier)