Package com.healthmarketscience.jackcess
Interface PropertyMap
-
- All Superinterfaces:
Iterable<PropertyMap.Property>
- All Known Implementing Classes:
MultiValueColumnPropertyMap,PropertyMapImpl
public interface PropertyMap extends Iterable<PropertyMap.Property>
Map of properties for a database object.- Author:
- James Ahlborn
- Usage:
- General: This class is general use.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classPropertyMap.DisplayControlEnum value constants for the DisplayControl propertystatic interfacePropertyMap.EnumValueInterface for enums which can be used as property values.static classPropertyMap.IMEModeEnum value constants for the IMEMode propertystatic classPropertyMap.IMESentenceModeEnum value constants for the IMESentenceMode propertystatic interfacePropertyMap.PropertyInfo about a property defined in a PropertyMap.static classPropertyMap.TextFormatEnum value constants for the TextFormat property
-
Field Summary
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description PropertyMap.Propertyget(String name)StringgetName()intgetSize()ObjectgetValue(String name)ObjectgetValue(String name, Object defaultValue)booleanisEmpty()PropertyMap.Propertyput(String name, DataType type, Object value)Creates a new (or updates an existing) property in the map.PropertyMap.Propertyput(String name, DataType type, Object value, boolean isDdl)Creates a new (or updates an existing) property in the map.PropertyMap.Propertyput(String name, DataType type, Object value, boolean isDdl, boolean isSkipHandler)Creates a new (or updates an existing) property in the map, setting both of the flag bits ms access defines.PropertyMap.Propertyput(String name, Object value)Creates a new (or updates an existing) property in the map.voidputAll(Iterable<? extends PropertyMap.Property> props)Puts all the given properties into this map.PropertyMap.Propertyremove(String name)Removes the property with the given namevoidsave()Saves the current state of this map.default Stream<PropertyMap.Property>stream()-
Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator
-
-
-
-
Field Detail
-
ACCESS_VERSION_PROP
static final String ACCESS_VERSION_PROP
- See Also:
- Constant Field Values
-
BUILD_PROP
static final String BUILD_PROP
- See Also:
- Constant Field Values
-
PROJ_VER_PROP
static final String PROJ_VER_PROP
- See Also:
- Constant Field Values
-
HAS_OFFLINE_LISTS_PROP
static final String HAS_OFFLINE_LISTS_PROP
- See Also:
- Constant Field Values
-
ANSI_QUERY_MODE_PROP
static final String ANSI_QUERY_MODE_PROP
- See Also:
- Constant Field Values
-
AUTO_COMPACT_PROP
static final String AUTO_COMPACT_PROP
- See Also:
- Constant Field Values
-
TRACK_NAME_AUTO_CORRECT_PROP
static final String TRACK_NAME_AUTO_CORRECT_PROP
- See Also:
- Constant Field Values
-
PERFORM_NAME_AUTO_CORRECT_PROP
static final String PERFORM_NAME_AUTO_CORRECT_PROP
- See Also:
- Constant Field Values
-
CHECK_TRUNCATED_NUM_FIELDS_PROP
static final String CHECK_TRUNCATED_NUM_FIELDS_PROP
- See Also:
- Constant Field Values
-
PICTURE_STORAGE_FORMAT_PROP
static final String PICTURE_STORAGE_FORMAT_PROP
- See Also:
- Constant Field Values
-
THEME_RESOURCE_NAME_PROP
static final String THEME_RESOURCE_NAME_PROP
- See Also:
- Constant Field Values
-
THEMED_FORM_CONTROLS_PROP
static final String THEMED_FORM_CONTROLS_PROP
- See Also:
- Constant Field Values
-
SHOW_DOCUMENT_TABS_PROP
static final String SHOW_DOCUMENT_TABS_PROP
- See Also:
- Constant Field Values
-
USE_MDI_MODE_PROP
static final String USE_MDI_MODE_PROP
- See Also:
- Constant Field Values
-
WEB_DESIGN_MODE_PROP
static final String WEB_DESIGN_MODE_PROP
- See Also:
- Constant Field Values
-
DESIGN_WITH_DATA_PROP
static final String DESIGN_WITH_DATA_PROP
- See Also:
- Constant Field Values
-
ALLOW_BUILT_IN_TOOLBARS_PROP
static final String ALLOW_BUILT_IN_TOOLBARS_PROP
- See Also:
- Constant Field Values
-
ALLOW_DATASHEET_SCHEMA_PROP
static final String ALLOW_DATASHEET_SCHEMA_PROP
- See Also:
- Constant Field Values
-
ALLOW_FULL_MENUS_PROP
static final String ALLOW_FULL_MENUS_PROP
- See Also:
- Constant Field Values
-
ALLOW_SHORTCUT_MENUS_PROP
static final String ALLOW_SHORTCUT_MENUS_PROP
- See Also:
- Constant Field Values
-
ALLOW_SPECIAL_KEYS_PROP
static final String ALLOW_SPECIAL_KEYS_PROP
- See Also:
- Constant Field Values
-
ALLOW_TOOLBAR_CHANGES_PROP
static final String ALLOW_TOOLBAR_CHANGES_PROP
- See Also:
- Constant Field Values
-
START_UP_SHOW_DB_WINDOW_PROP
static final String START_UP_SHOW_DB_WINDOW_PROP
- See Also:
- Constant Field Values
-
START_UP_SHOW_STATUS_BAR_PROP
static final String START_UP_SHOW_STATUS_BAR_PROP
- See Also:
- Constant Field Values
-
USE_APP_ICON_FOR_FRM_RPT_PROP
static final String USE_APP_ICON_FOR_FRM_RPT_PROP
- See Also:
- Constant Field Values
-
NAV_PANE_CATEGORY_PROP
static final String NAV_PANE_CATEGORY_PROP
- See Also:
- Constant Field Values
-
NAV_PANE_CLOSED_PROP
static final String NAV_PANE_CLOSED_PROP
- See Also:
- Constant Field Values
-
NAV_PANE_SORT_BY_PROP
static final String NAV_PANE_SORT_BY_PROP
- See Also:
- Constant Field Values
-
NAV_PANE_VIEW_BY_PROP
static final String NAV_PANE_VIEW_BY_PROP
- See Also:
- Constant Field Values
-
NAV_PANE_WIDTH_PROP
static final String NAV_PANE_WIDTH_PROP
- See Also:
- Constant Field Values
-
NAV_PANE_SEARCH_BAR_PROP
static final String NAV_PANE_SEARCH_BAR_PROP
- See Also:
- Constant Field Values
-
SHOW_VALUES_LIMIT_PROP
static final String SHOW_VALUES_LIMIT_PROP
- See Also:
- Constant Field Values
-
SHOW_VALUES_IN_INDEXED_PROP
static final String SHOW_VALUES_IN_INDEXED_PROP
- See Also:
- Constant Field Values
-
SHOW_VALUES_IN_NON_INDEXED_PROP
static final String SHOW_VALUES_IN_NON_INDEXED_PROP
- See Also:
- Constant Field Values
-
SHOW_VALUES_IN_REMOTE_PROP
static final String SHOW_VALUES_IN_REMOTE_PROP
- See Also:
- Constant Field Values
-
REPLICATE_PROJECT_PROP
static final String REPLICATE_PROJECT_PROP
- See Also:
- Constant Field Values
-
TITLE_PROP
static final String TITLE_PROP
- See Also:
- Constant Field Values
-
AUTHOR_PROP
static final String AUTHOR_PROP
- See Also:
- Constant Field Values
-
COMPANY_PROP
static final String COMPANY_PROP
- See Also:
- Constant Field Values
-
DEFAULT_VALUE_PROP
static final String DEFAULT_VALUE_PROP
- See Also:
- Constant Field Values
-
REQUIRED_PROP
static final String REQUIRED_PROP
- See Also:
- Constant Field Values
-
ALLOW_ZERO_LEN_PROP
static final String ALLOW_ZERO_LEN_PROP
- See Also:
- Constant Field Values
-
DECIMAL_PLACES_PROP
static final String DECIMAL_PLACES_PROP
- See Also:
- Constant Field Values
-
FORMAT_PROP
static final String FORMAT_PROP
- See Also:
- Constant Field Values
-
INPUT_MASK_PROP
static final String INPUT_MASK_PROP
- See Also:
- Constant Field Values
-
CAPTION_PROP
static final String CAPTION_PROP
- See Also:
- Constant Field Values
-
VALIDATION_RULE_PROP
static final String VALIDATION_RULE_PROP
- See Also:
- Constant Field Values
-
VALIDATION_TEXT_PROP
static final String VALIDATION_TEXT_PROP
- See Also:
- Constant Field Values
-
GUID_PROP
static final String GUID_PROP
- See Also:
- Constant Field Values
-
DESCRIPTION_PROP
static final String DESCRIPTION_PROP
- See Also:
- Constant Field Values
-
RESULT_TYPE_PROP
static final String RESULT_TYPE_PROP
- See Also:
- Constant Field Values
-
EXPRESSION_PROP
static final String EXPRESSION_PROP
- See Also:
- Constant Field Values
-
ALLOW_MULTI_VALUE_PROP
static final String ALLOW_MULTI_VALUE_PROP
- See Also:
- Constant Field Values
-
ROW_SOURCE_TYPE_PROP
static final String ROW_SOURCE_TYPE_PROP
- See Also:
- Constant Field Values
-
ROW_SOURCE_PROP
static final String ROW_SOURCE_PROP
- See Also:
- Constant Field Values
-
BOUND_COLUMN_PROP
static final String BOUND_COLUMN_PROP
- See Also:
- Constant Field Values
-
COLUMN_COUNT_PROP
static final String COLUMN_COUNT_PROP
- See Also:
- Constant Field Values
-
COLUMN_WIDTHS_PROP
static final String COLUMN_WIDTHS_PROP
- See Also:
- Constant Field Values
-
LIMIT_TO_LIST_PROP
static final String LIMIT_TO_LIST_PROP
- See Also:
- Constant Field Values
-
DISPLAY_CONTROL_PROP
static final String DISPLAY_CONTROL_PROP
- See Also:
- Constant Field Values
-
TEXT_FORMAT_PROP
static final String TEXT_FORMAT_PROP
- See Also:
- Constant Field Values
-
IME_MODE_PROP
static final String IME_MODE_PROP
- See Also:
- Constant Field Values
-
IME_SENTENCE_MODE_PROP
static final String IME_SENTENCE_MODE_PROP
- See Also:
- Constant Field Values
-
UNICODE_COMPRESSION_PROP
static final String UNICODE_COMPRESSION_PROP
- See Also:
- Constant Field Values
-
APPEND_ONLY_PROP
static final String APPEND_ONLY_PROP
- See Also:
- Constant Field Values
-
TEXT_ALIGN_PROP
static final String TEXT_ALIGN_PROP
- See Also:
- Constant Field Values
-
AGGREGATE_TYPE_PROP
static final String AGGREGATE_TYPE_PROP
- See Also:
- Constant Field Values
-
CURRENCY_LCID_PROP
static final String CURRENCY_LCID_PROP
- See Also:
- Constant Field Values
-
COLUMN_HIDDEN_PROP
static final String COLUMN_HIDDEN_PROP
- See Also:
- Constant Field Values
-
COLUMN_ORDER_PROP
static final String COLUMN_ORDER_PROP
- See Also:
- Constant Field Values
-
COLUMN_WIDTH_PROP
static final String COLUMN_WIDTH_PROP
- See Also:
- Constant Field Values
-
NAME_MAP_PROP
static final String NAME_MAP_PROP
- See Also:
- Constant Field Values
-
DEFAULT_VIEW_PROP
static final String DEFAULT_VIEW_PROP
- See Also:
- Constant Field Values
-
ORIENTATION_PROP
static final String ORIENTATION_PROP
- See Also:
- Constant Field Values
-
ORDER_BY_ON_PROP
static final String ORDER_BY_ON_PROP
- See Also:
- Constant Field Values
-
ORDER_BY_ON_LOAD_PROP
static final String ORDER_BY_ON_LOAD_PROP
- See Also:
- Constant Field Values
-
FILTER_ON_LOAD_PROP
static final String FILTER_ON_LOAD_PROP
- See Also:
- Constant Field Values
-
TOTALS_ROW_PROP
static final String TOTALS_ROW_PROP
- See Also:
- Constant Field Values
-
HIDE_NEW_FIELD_PROP
static final String HIDE_NEW_FIELD_PROP
- See Also:
- Constant Field Values
-
PUBLISH_TO_WEB_PROP
static final String PUBLISH_TO_WEB_PROP
- See Also:
- Constant Field Values
-
READ_ONLY_WHEN_DISCONNECTED_PROP
static final String READ_ONLY_WHEN_DISCONNECTED_PROP
- See Also:
- Constant Field Values
-
DISPLAY_VIEWS_ON_SHAREPOINT_PROP
static final String DISPLAY_VIEWS_ON_SHAREPOINT_PROP
- See Also:
- Constant Field Values
-
BACK_TINT_PROP
static final String BACK_TINT_PROP
- See Also:
- Constant Field Values
-
BACK_SHADE_PROP
static final String BACK_SHADE_PROP
- See Also:
- Constant Field Values
-
ALTERNATE_BACK_TINT_PROP
static final String ALTERNATE_BACK_TINT_PROP
- See Also:
- Constant Field Values
-
ALTERNATE_BACK_SHADE_PROP
static final String ALTERNATE_BACK_SHADE_PROP
- See Also:
- Constant Field Values
-
ALTERNATE_BACK_THEME_COLOR_INDEX_PROP
static final String ALTERNATE_BACK_THEME_COLOR_INDEX_PROP
- See Also:
- Constant Field Values
-
DATASHEET_FORE_THEME_COLOR_INDEX_PROP
static final String DATASHEET_FORE_THEME_COLOR_INDEX_PROP
- See Also:
- Constant Field Values
-
DATASHEET_GRIDLINES_THEME_COLOR_INDEX_PROP
static final String DATASHEET_GRIDLINES_THEME_COLOR_INDEX_PROP
- See Also:
- Constant Field Values
-
THEME_FONT_INDEX_PROP
static final String THEME_FONT_INDEX_PROP
- See Also:
- Constant Field Values
-
QUERY_NAME_MAP_PROP
static final String QUERY_NAME_MAP_PROP
- See Also:
- Constant Field Values
-
ODBC_TIMEOUT_PROP
static final String ODBC_TIMEOUT_PROP
- See Also:
- Constant Field Values
-
RECORD_LOCKS_PROP
static final String RECORD_LOCKS_PROP
- See Also:
- Constant Field Values
-
RECORDSET_TYPE_PROP
static final String RECORDSET_TYPE_PROP
- See Also:
- Constant Field Values
-
USE_TRANSACTION_PROP
static final String USE_TRANSACTION_PROP
- See Also:
- Constant Field Values
-
FAIL_ON_ERROR_PROP
static final String FAIL_ON_ERROR_PROP
- See Also:
- Constant Field Values
-
LOG_MESSAGES_PROP
static final String LOG_MESSAGES_PROP
- See Also:
- Constant Field Values
-
-
Method Detail
-
getName
String getName()
-
getSize
int getSize()
-
isEmpty
boolean isEmpty()
-
get
PropertyMap.Property get(String name)
- Returns:
- the property with the given name, if any
-
getValue
Object getValue(String name)
- Returns:
- the value of the property with the given name, if any
-
getValue
Object getValue(String name, Object defaultValue)
- Returns:
- the value of the property with the given name, if any, otherwise the given defaultValue
-
put
PropertyMap.Property put(String name, Object value)
Creates a new (or updates an existing) property in the map. Attempts to determine the type of the property based on the name and value (the property names listed above have their types builtin, otherwise the type of the value is used).Note, this change will not be persisted until the
save()method has been called.- Returns:
- the newly created (or updated) property
- Throws:
IllegalArgumentException- if the type of the property could not be determined automatically
-
put
PropertyMap.Property put(String name, DataType type, Object value)
Creates a new (or updates an existing) property in the map.Note, this change will not be persisted until the
save()method has been called.- Returns:
- the newly created (or updated) property
-
put
PropertyMap.Property put(String name, DataType type, Object value, boolean isDdl)
Creates a new (or updates an existing) property in the map.Note, this change will not be persisted until the
save()method has been called.- Returns:
- the newly created (or updated) property
-
put
PropertyMap.Property put(String name, DataType type, Object value, boolean isDdl, boolean isSkipHandler)
Creates a new (or updates an existing) property in the map, setting both of the flag bits ms access defines.Note, this change will not be persisted until the
save()method has been called.- Returns:
- the newly created (or updated) property
-
putAll
void putAll(Iterable<? extends PropertyMap.Property> props)
Puts all the given properties into this map.- Parameters:
props- the properties to put into this map (nullis tolerated and ignored).
-
remove
PropertyMap.Property remove(String name)
Removes the property with the given name- Returns:
- the removed property, or
nullif none found
-
save
void save() throws IOException
Saves the current state of this map.- Throws:
IOException
-
stream
default Stream<PropertyMap.Property> stream()
- Returns:
- a Stream using the default Iterator.
-
-