Class IdentifierRule
- java.lang.Object
-
- org.apache.openjpa.lib.identifier.IdentifierRule
-
public class IdentifierRule extends 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 Summary
Fields Modifier and Type Field Description static StringDEFAULT_RULEstatic Set<String>EMPTY_SETstatic charUNDERSCORE
-
Constructor Summary
Constructors Constructor Description IdentifierRule()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleangetAllowCompaction()booleangetCanDelimit()booleangetDelimitReservedWords()intgetMaxLength()booleangetMustDelimit()StringgetName()Set<String>getReservedWords()StringgetSpecialCharacters()booleanisAllowTruncation()booleanisMustBeginWithLetter()booleanisNullable()booleanisOnlyLettersDigitsUnderscores()booleanisReservedWord(String identifier)booleanrequiresDelimiters(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 wordsvoidsetAllowCompaction(boolean allowCompaction)voidsetAllowTruncation(boolean allowTruncation)voidsetCanDelimit(boolean canDelimit)voidsetDelimitReservedWords(boolean delimitReservedWords)voidsetMaxLength(int maxLength)voidsetMustBeginWithLetter(boolean mustBeginWithLetter)voidsetMustDelimit(boolean mustDelimit)voidsetName(String name)voidsetNullable(boolean nullable)voidsetOnlyLettersDigitsUnderscores(boolean onlyLettersDigitsUnderscores)voidsetReservedWords(Set<String> reservedWords)voidsetSpecialCharacters(String specialCharacters)
-
-
-
Field Detail
-
DEFAULT_RULE
public static final String DEFAULT_RULE
- See Also:
- Constant Field Values
-
UNDERSCORE
public static char UNDERSCORE
-
-
Method Detail
-
setName
public void setName(String name)
-
getName
public 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()
-
setSpecialCharacters
public void setSpecialCharacters(String specialCharacters)
-
getSpecialCharacters
public String getSpecialCharacters()
-
setDelimitReservedWords
public void setDelimitReservedWords(boolean delimitReservedWords)
-
getDelimitReservedWords
public boolean getDelimitReservedWords()
-
requiresDelimiters
public boolean requiresDelimiters(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(String identifier)
-
-