org.apache.openjpa.lib.identifier
Class IdentifierRule
java.lang.Object
   org.apache.openjpa.lib.identifier.IdentifierRule
org.apache.openjpa.lib.identifier.IdentifierRule
- Direct Known Subclasses: 
- DBIdentifierRule
- 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.
 
 
 
| Methods inherited from class java.lang.Object | 
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
 
EMPTY_SET
public static final Set<String> EMPTY_SET
DEFAULT_RULE
public static final String DEFAULT_RULE
- See Also:
- Constant Field Values
UNDERSCORE
public static char UNDERSCORE
IdentifierRule
public IdentifierRule()
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()
- 
 
setReservedWords
public void setReservedWords(Set<String> reservedWords)
- 
 
getReservedWords
public Set<String> getReservedWords()
- 
 
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)
- 
 
Copyright © 2006-2013 Apache Software Foundation. All Rights Reserved.