APIdia Launch Partner
Top Description Inners Fields Methods
io.github.spannm.jackcess

public Interface PropertyMap

extends Iterable<PropertyMap.Property>
Known Direct Implementers
io.github.spannm.jackcess.impl.PropertyMapImpl, io.github.spannm.jackcess.impl.complex.MultiValueColumnPropertyMap
Imports
java.io.IOException, java.util.stream.Stream, .StreamSupport

Map of properties for a database object.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
PropertyMap.DisplayControl

Enum value constants for the DisplayControl property

public static interface
PropertyMap.EnumValue

Interface for enums which can be used as property values.

public static enum
PropertyMap.IMEMode

Enum value constants for the IMEMode property

public static enum
PropertyMap.IMESentenceMode

Enum value constants for the IMESentenceMode property

public static interface
PropertyMap.Property

Info about a property defined in a PropertyMap.

public static enum
PropertyMap.TextFormat

Enum value constants for the TextFormat property

Field Summary

Modifier and TypeField and Description
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String
public static final String

Method Summary

Modifier and TypeMethod and Description
public PropertyMap.Property

Returns:

the property with the given name, if any
get
(String name)

Returns the property with the given name, if any.

public String

Returns:

the name of the database object to which this property map belongs
getName
()

Returns the name of the database object to which this property map belongs.

public int

Returns:

the number of properties currently in this map
getSize
()

Returns the number of properties currently in this map.

public Object

Returns:

the value of the property with the given name, if any
getValue
(String name)

Returns the value of the property with the given name, if any.

public Object

Returns:

the value of the property with the given name, if any, otherwise the given defaultValue
getValue
(String name, Object defaultValue)

Returns the value of the property with the given name, if any, otherwise the given defaultValue.

public boolean

Returns:

true if this map has no properties
isEmpty
()

Returns true if this map has no properties.

public PropertyMap.Property

Returns:

the newly created (or updated) property
put
(String name, Object value)

Creates a new (or updates an existing) property in the map.

public PropertyMap.Property

Returns:

the newly created (or updated) property
put
(String name, DataType type, Object value)

Creates a new (or updates an existing) property in the map.

public PropertyMap.Property

Returns:

the newly created (or updated) property
put
(String name, DataType type, Object value, boolean isDdl)

Creates a new (or updates an existing) property in the map.

public void
putAll(Iterable<? extends PropertyMap.Property>
the properties to put into this map (null is tolerated and ignored).
props
)

Puts all the given properties into this map.

public PropertyMap.Property

Returns:

the removed property, or null if none found
remove
(String name)

Removes the property with the given name

public void
save()

Saves the current state of this map.

public default Stream<PropertyMap.Property>

Returns:

a Stream using the default Iterator.
stream
()

Returns a Stream using the default Iterator.

Inherited from java.lang.Iterable:
forEachiteratorspliterator

Field Detail

ACCESS_VERSION_PROPback to summary
public static final String ACCESS_VERSION_PROP
ALLOW_MULTI_VALUE_PROPback to summary
public static final String ALLOW_MULTI_VALUE_PROP
ALLOW_ZERO_LEN_PROPback to summary
public static final String ALLOW_ZERO_LEN_PROP
AUTHOR_PROPback to summary
public static final String AUTHOR_PROP
CAPTION_PROPback to summary
public static final String CAPTION_PROP
COMPANY_PROPback to summary
public static final String COMPANY_PROP
DECIMAL_PLACES_PROPback to summary
public static final String DECIMAL_PLACES_PROP
DEFAULT_VALUE_PROPback to summary
public static final String DEFAULT_VALUE_PROP
DESCRIPTION_PROPback to summary
public static final String DESCRIPTION_PROP
DISPLAY_CONTROL_PROPback to summary
public static final String DISPLAY_CONTROL_PROP
EXPRESSION_PROPback to summary
public static final String EXPRESSION_PROP
FORMAT_PROPback to summary
public static final String FORMAT_PROP
GUID_PROPback to summary
public static final String GUID_PROP
IME_MODE_PROPback to summary
public static final String IME_MODE_PROP
IME_SENTENCE_MODE_PROPback to summary
public static final String IME_SENTENCE_MODE_PROP
INPUT_MASK_PROPback to summary
public static final String INPUT_MASK_PROP
REQUIRED_PROPback to summary
public static final String REQUIRED_PROP
RESULT_TYPE_PROPback to summary
public static final String RESULT_TYPE_PROP
ROW_SOURCE_PROPback to summary
public static final String ROW_SOURCE_PROP
ROW_SOURCE_TYPE_PROPback to summary
public static final String ROW_SOURCE_TYPE_PROP
TEXT_FORMAT_PROPback to summary
public static final String TEXT_FORMAT_PROP
TITLE_PROPback to summary
public static final String TITLE_PROP
VALIDATION_RULE_PROPback to summary
public static final String VALIDATION_RULE_PROP
VALIDATION_TEXT_PROPback to summary
public static final String VALIDATION_TEXT_PROP

Method Detail

getback to summary
public PropertyMap.Property get(String name)

Returns the property with the given name, if any.

Returns:PropertyMap.Property

the property with the given name, if any

getNameback to summary
public String getName()

Returns the name of the database object to which this property map belongs.

Returns:String

the name of the database object to which this property map belongs

getSizeback to summary
public int getSize()

Returns the number of properties currently in this map.

Returns:int

the number of properties currently in this map

getValueback to summary
public Object getValue(String name)

Returns the value of the property with the given name, if any.

Returns:Object

the value of the property with the given name, if any

getValueback to summary
public Object getValue(String name, Object defaultValue)

Returns the value of the property with the given name, if any, otherwise the given defaultValue.

Returns:Object

the value of the property with the given name, if any, otherwise the given defaultValue

isEmptyback to summary
public boolean isEmpty()

Returns true if this map has no properties.

Returns:boolean

true if this map has no properties

putback to summary
public 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:PropertyMap.Property

the newly created (or updated) property

Exceptions
IllegalArgumentException:
if the type of the property could not be determined automatically
putback to summary
public 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:PropertyMap.Property

the newly created (or updated) property

putback to summary
public 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:PropertyMap.Property

the newly created (or updated) property

putAllback to summary
public void putAll(Iterable<? extends PropertyMap.Property> props)

Puts all the given properties into this map.

Parameters
props:Iterable<? extends PropertyMap.Property>

the properties to put into this map (null is tolerated and ignored).

removeback to summary
public PropertyMap.Property remove(String name)

Removes the property with the given name

Returns:PropertyMap.Property

the removed property, or null if none found

saveback to summary
public void save() throws IOException

Saves the current state of this map.

streamback to summary
public default Stream<PropertyMap.Property> stream()

Returns a Stream using the default Iterator.

Returns:Stream<PropertyMap.Property>

a Stream using the default Iterator.

io.github.spannm.jackcess back to summary

public final Enum PropertyMap.DisplayControl

extends Enum<PropertyMap.DisplayControl>
implements EnumValue
Class Inheritance
All Implemented Interfaces
io.github.spannm.jackcess.PropertyMap.EnumValue

Enum value constants for the DisplayControl property

Field Summary

Modifier and TypeField and Description
public static final PropertyMap.DisplayControl
public static final PropertyMap.DisplayControl
public static final PropertyMap.DisplayControl
public static final PropertyMap.DisplayControl
public static final PropertyMap.DisplayControl
public static final PropertyMap.DisplayControl
public static final PropertyMap.DisplayControl
public static final PropertyMap.DisplayControl
public static final PropertyMap.DisplayControl
public static final PropertyMap.DisplayControl
public static final PropertyMap.DisplayControl
public static final PropertyMap.DisplayControl
public static final PropertyMap.DisplayControl
public static final PropertyMap.DisplayControl
public static final PropertyMap.DisplayControl
public static final PropertyMap.DisplayControl
public static final PropertyMap.DisplayControl
public static final PropertyMap.DisplayControl
public static final PropertyMap.DisplayControl
public static final PropertyMap.DisplayControl
public static final PropertyMap.DisplayControl
public static final PropertyMap.DisplayControl
private final Short
public static final PropertyMap.DisplayControl

Constructor Summary

AccessConstructor and Description
private
DisplayControl(int value)

Method Summary

Modifier and TypeMethod and Description
public Short
getValue()

Implements io.github.spannm.jackcess.PropertyMap.EnumValue.getValue.

Returns the property value which should be stored in the db.

public String
toString()

Overrides java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration.

public static PropertyMap.DisplayControl
public static PropertyMap.DisplayControl[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinalvalueOf

Field Detail

BOUND_OBJECT_FRAMEback to summary
public static final PropertyMap.DisplayControl BOUND_OBJECT_FRAME
CHECK_BOXback to summary
public static final PropertyMap.DisplayControl CHECK_BOX
COMBO_BOXback to summary
public static final PropertyMap.DisplayControl COMBO_BOX
COMMAND_BUTTONback to summary
public static final PropertyMap.DisplayControl COMMAND_BUTTON
CUSTOM_CONTROLback to summary
public static final PropertyMap.DisplayControl CUSTOM_CONTROL
EMPTY_CELLback to summary
public static final PropertyMap.DisplayControl EMPTY_CELL
IMAGEback to summary
public static final PropertyMap.DisplayControl IMAGE
LABELback to summary
public static final PropertyMap.DisplayControl LABEL
LINEback to summary
public static final PropertyMap.DisplayControl LINE
LIST_BOXback to summary
public static final PropertyMap.DisplayControl LIST_BOX
NAVIGATION_BUTTONback to summary
public static final PropertyMap.DisplayControl NAVIGATION_BUTTON
NAVIGATION_CONTROLback to summary
public static final PropertyMap.DisplayControl NAVIGATION_CONTROL
OBJECT_FRAMEback to summary
public static final PropertyMap.DisplayControl OBJECT_FRAME
OPTION_BUTTONback to summary
public static final PropertyMap.DisplayControl OPTION_BUTTON
OPTION_GROUPback to summary
public static final PropertyMap.DisplayControl OPTION_GROUP
PAGEback to summary
public static final PropertyMap.DisplayControl PAGE
PAGE_BREAKback to summary
public static final PropertyMap.DisplayControl PAGE_BREAK
RECTANGLEback to summary
public static final PropertyMap.DisplayControl RECTANGLE
SUB_FORMback to summary
public static final PropertyMap.DisplayControl SUB_FORM
TAB_CTLback to summary
public static final PropertyMap.DisplayControl TAB_CTL
TEXT_BOXback to summary
public static final PropertyMap.DisplayControl TEXT_BOX
TOGGLE_BUTTONback to summary
public static final PropertyMap.DisplayControl TOGGLE_BUTTON
valueback to summary
private final Short value
WEB_BROWSERback to summary
public static final PropertyMap.DisplayControl WEB_BROWSER

Constructor Detail

DisplayControlback to summary
private DisplayControl(int value)

Method Detail

getValueback to summary
public Short getValue()

Implements io.github.spannm.jackcess.PropertyMap.EnumValue.getValue.

Doc from io.github.spannm.jackcess.PropertyMap.EnumValue.getValue.

Returns the property value which should be stored in the db.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Enum.toString.

Doc from java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists.

Annotations
@Override
valueOfback to summary
public static PropertyMap.DisplayControl valueOf(String name)
valuesback to summary
public static PropertyMap.DisplayControl[] values()
io.github.spannm.jackcess back to summary

public Interface PropertyMap.EnumValue

Known Direct Implementers
io.github.spannm.jackcess.PropertyMap.DisplayControl, io.github.spannm.jackcess.PropertyMap.TextFormat, io.github.spannm.jackcess.PropertyMap.IMEMode, io.github.spannm.jackcess.PropertyMap.IMESentenceMode

Interface for enums which can be used as property values.

Method Summary

Modifier and TypeMethod and Description
public Object

Returns:

the property value which should be stored in the db
getValue
()

Returns the property value which should be stored in the db.

Method Detail

getValueback to summary
public Object getValue()

Returns the property value which should be stored in the db.

Returns:Object

the property value which should be stored in the db

io.github.spannm.jackcess back to summary

public final Enum PropertyMap.IMEMode

extends Enum<PropertyMap.IMEMode>
implements EnumValue
Class Inheritance
All Implemented Interfaces
io.github.spannm.jackcess.PropertyMap.EnumValue

Enum value constants for the IMEMode property

Field Summary

Modifier and TypeField and Description
public static final PropertyMap.IMEMode
public static final PropertyMap.IMEMode
public static final PropertyMap.IMEMode
public static final PropertyMap.IMEMode
public static final PropertyMap.IMEMode
public static final PropertyMap.IMEMode
public static final PropertyMap.IMEMode
public static final PropertyMap.IMEMode
public static final PropertyMap.IMEMode
public static final PropertyMap.IMEMode
public static final PropertyMap.IMEMode
private final Byte

Constructor Summary

AccessConstructor and Description
private
IMEMode(int value)

Method Summary

Modifier and TypeMethod and Description
public Byte
getValue()

Implements io.github.spannm.jackcess.PropertyMap.EnumValue.getValue.

Returns the property value which should be stored in the db.

public String
toString()

Overrides java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration.

public static PropertyMap.IMEMode
public static PropertyMap.IMEMode[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinalvalueOf

Field Detail

ALPHAback to summary
public static final PropertyMap.IMEMode ALPHA
ALPHAFULLback to summary
public static final PropertyMap.IMEMode ALPHAFULL
DISABLEback to summary
public static final PropertyMap.IMEMode DISABLE
HANGULback to summary
public static final PropertyMap.IMEMode HANGUL
HANGULFULLback to summary
public static final PropertyMap.IMEMode HANGULFULL
HIRAGANAback to summary
public static final PropertyMap.IMEMode HIRAGANA
KATAKANAback to summary
public static final PropertyMap.IMEMode KATAKANA
KATAKANAHALFback to summary
public static final PropertyMap.IMEMode KATAKANAHALF
NOCONTROLback to summary
public static final PropertyMap.IMEMode NOCONTROL
OFFback to summary
public static final PropertyMap.IMEMode OFF
ONback to summary
public static final PropertyMap.IMEMode ON
valueback to summary
private final Byte value

Constructor Detail

IMEModeback to summary
private IMEMode(int value)

Method Detail

getValueback to summary
public Byte getValue()

Implements io.github.spannm.jackcess.PropertyMap.EnumValue.getValue.

Doc from io.github.spannm.jackcess.PropertyMap.EnumValue.getValue.

Returns the property value which should be stored in the db.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Enum.toString.

Doc from java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists.

Annotations
@Override
valueOfback to summary
public static PropertyMap.IMEMode valueOf(String name)
valuesback to summary
public static PropertyMap.IMEMode[] values()
io.github.spannm.jackcess back to summary

public final Enum PropertyMap.IMESentenceMode

extends Enum<PropertyMap.IMESentenceMode>
implements EnumValue
Class Inheritance
All Implemented Interfaces
io.github.spannm.jackcess.PropertyMap.EnumValue

Enum value constants for the IMESentenceMode property

Field Summary

Modifier and TypeField and Description
public static final PropertyMap.IMESentenceMode
public static final PropertyMap.IMESentenceMode
public static final PropertyMap.IMESentenceMode
public static final PropertyMap.IMESentenceMode
private final Byte

Constructor Summary

AccessConstructor and Description
private
IMESentenceMode(int value)

Method Summary

Modifier and TypeMethod and Description
public Byte
getValue()

Implements io.github.spannm.jackcess.PropertyMap.EnumValue.getValue.

Returns the property value which should be stored in the db.

public String
toString()

Overrides java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration.

public static PropertyMap.IMESentenceMode
public static PropertyMap.IMESentenceMode[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinalvalueOf

Field Detail

NONEback to summary
public static final PropertyMap.IMESentenceMode NONE
NORMALback to summary
public static final PropertyMap.IMESentenceMode NORMAL
PLURALback to summary
public static final PropertyMap.IMESentenceMode PLURAL
SPEAKINGback to summary
public static final PropertyMap.IMESentenceMode SPEAKING
valueback to summary
private final Byte value

Constructor Detail

IMESentenceModeback to summary
private IMESentenceMode(int value)

Method Detail

getValueback to summary
public Byte getValue()

Implements io.github.spannm.jackcess.PropertyMap.EnumValue.getValue.

Doc from io.github.spannm.jackcess.PropertyMap.EnumValue.getValue.

Returns the property value which should be stored in the db.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Enum.toString.

Doc from java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists.

Annotations
@Override
valueOfback to summary
public static PropertyMap.IMESentenceMode valueOf(String name)
valuesback to summary
public static PropertyMap.IMESentenceMode[] values()
io.github.spannm.jackcess back to summary

public Interface PropertyMap.Property

Known Direct Implementers
io.github.spannm.jackcess.impl.PropertyMapImpl.PropertyImpl

Info about a property defined in a PropertyMap.

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the name of this property
getName
()

Returns the name of this property.

public DataType

Returns:

the data type of this property's value
getType
()

Returns the data type of this property's value.

public Object

Returns:

the current value of this property
getValue
()

Returns the current value of this property.

public boolean
isDdl()

Whether or not this property is a DDL object.

public void
setValue(Object newValue)

Sets the new value for this property.

Method Detail

getNameback to summary
public String getName()

Returns the name of this property.

Returns:String

the name of this property

getTypeback to summary
public DataType getType()

Returns the data type of this property's value.

Returns:DataType

the data type of this property's value

getValueback to summary
public Object getValue()

Returns the current value of this property.

Returns:Object

the current value of this property

isDdlback to summary
public boolean isDdl()

Whether or not this property is a DDL object. If true, users can't change or delete the property in access without the dbSecWriteDef permission. Additionally, certain properties must be flagged correctly or the access engine may not recognize them correctly.

setValueback to summary
public void setValue(Object newValue)

Sets the new value for this property.

Note, this change will not be persisted until the PropertyMap#save method has been called.

io.github.spannm.jackcess back to summary

public final Enum PropertyMap.TextFormat

extends Enum<PropertyMap.TextFormat>
implements EnumValue
Class Inheritance
All Implemented Interfaces
io.github.spannm.jackcess.PropertyMap.EnumValue

Enum value constants for the TextFormat property

Field Summary

Modifier and TypeField and Description
public static final PropertyMap.TextFormat
public static final PropertyMap.TextFormat
private final Byte

Constructor Summary

AccessConstructor and Description
private
TextFormat(int value)

Method Summary

Modifier and TypeMethod and Description
public Byte
getValue()

Implements io.github.spannm.jackcess.PropertyMap.EnumValue.getValue.

Returns the property value which should be stored in the db.

public String
toString()

Overrides java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration.

public static PropertyMap.TextFormat
public static PropertyMap.TextFormat[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinalvalueOf

Field Detail

HTMLRICHTEXTback to summary
public static final PropertyMap.TextFormat HTMLRICHTEXT
PLAINback to summary
public static final PropertyMap.TextFormat PLAIN
valueback to summary
private final Byte value

Constructor Detail

TextFormatback to summary
private TextFormat(int value)

Method Detail

getValueback to summary
public Byte getValue()

Implements io.github.spannm.jackcess.PropertyMap.EnumValue.getValue.

Doc from io.github.spannm.jackcess.PropertyMap.EnumValue.getValue.

Returns the property value which should be stored in the db.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Enum.toString.

Doc from java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists.

Annotations
@Override
valueOfback to summary
public static PropertyMap.TextFormat valueOf(String name)
valuesback to summary
public static PropertyMap.TextFormat[] values()