Interface ColumnNameMatcher

All Known Implementing Classes:
CaseInsensitiveColumnNameMatcher, SnakeCaseColumnNameMatcher

public interface ColumnNameMatcher
Strategy for matching SQL column names to Java property, field, or parameter names.
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    columnNameMatches​(String columnName, String javaName)
    Returns whether the column name fits the given Java identifier name.
    default boolean
    columnNameStartsWith​(String columnName, String prefix)
    Return whether the column name starts with the given prefix, according to the matching strategy of this ColumnNameMatcher.
  • Method Details

    • columnNameMatches

      boolean columnNameMatches(String columnName, String javaName)
      Returns whether the column name fits the given Java identifier name.
      Parameters:
      columnName - the SQL column name
      javaName - the Java property, field, or parameter name
      Returns:
      whether the given names are logically equivalent
    • columnNameStartsWith

      default boolean columnNameStartsWith(String columnName, String prefix)
      Return whether the column name starts with the given prefix, according to the matching strategy of this ColumnNameMatcher. This method is used by reflective mappers to short-circuit nested mapping when no column names begin with the nested prefix. By default, this method returns columnName.startWith(prefix). Third party implementations should override this method to match prefixes by the same criteria as columnNameMatches(String, String).
      Parameters:
      columnName - the column name to test
      prefix - the prefix to test for
      Returns:
      whether the column name begins with the prefix.
      Since:
      3.5.0