Class PropertyMapDB<T>
java.lang.Object
ghidra.program.database.properties.PropertyMapDB<T>
- Type Parameters:
T
- property value type
- All Implemented Interfaces:
PropertyMap<T>
- Direct Known Subclasses:
IntPropertyMapDB
,LongPropertyMapDB
,ObjectPropertyMapDB
,StringPropertyMapDB
,UnsupportedMapDB
,VoidPropertyMapDB
Abstract class which defines a map containing properties over a set of addresses.
The map is stored within a database table.
-
Field Summary
Modifier and TypeFieldDescriptionprotected AddressMap
protected ObjectCache
protected ChangeManager
protected DBHandle
protected static final int
protected ErrorHandler
protected Lock
protected String
protected static final String[]
protected static final Field[]
protected static final int
protected Table
protected Schema
protected static final String[]
-
Method Summary
Modifier and TypeMethodDescriptionprotected void
createTable
(Field valueField) Create the default propertyTable.void
delete()
Delete this property map and all underlying tables.getAddressKeyIterator
(Address start, boolean before) Get an iterator over the long address keys which contain a property value.getAddressKeyIterator
(Address start, Address end, boolean atStart) Get an iterator over the long address keys which contain a property value.getAddressKeyIterator
(AddressSetView set, boolean atStart) Get an iterator over the long address keys which contain a property value.Get the first Address where a property value exists.Get the last Address where a property value exists.getName()
Get the name for this property map.Get the next address where the property value exists.Get the previous Address where a property value exists.Returns an iterator over the addresses that a property value.getPropertyIterator
(Address start, boolean forward) Returns an iterator over the address having a property value.getPropertyIterator
(Address start, Address end) Returns an iterator over the indices having a property value.getPropertyIterator
(Address start, Address end, boolean forward) Returns an iterator over addresses that have a property value.Returns an iterator over the addresses that have a property value and are in the given address set.getPropertyIterator
(AddressSetView asv, boolean forward) Returns an iterator over the addresses that have a property value and are in the given address set.int
getSize()
Get the number of properties in the map.protected String
Get the default property table name for this property map.static String
getTableName
(String propertyName) boolean
hasProperty
(Address addr) returns whether there is a property value at addr.boolean
intersects
(Address startAddr, Address endAddr) Given two addresses, indicate whether there is an address in that range (inclusive) having the property.boolean
intersects
(AddressSetView set) Indicate whether there is an address within the set which exists within this map.void
Invalidates the cache.void
Moves the properties defined in the range from the start address thru the end address to now be located beginning at the newStart address.boolean
Remove the property value at the given address.boolean
removeRange
(Address startAddr, Address endAddr) Removes all property values within a given range.void
setCacheSize
(int size) Adjust the size of the underlying read cache.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface ghidra.program.model.util.PropertyMap
add, get, getValueClass
-
Field Details
-
SCHEMA_FIELD_NAMES
-
NO_SCHEMA_FIELD_NAMES
-
NO_SCHEMA_FIELDS
-
PROPERTY_VALUE_COL
protected static final int PROPERTY_VALUE_COL- See Also:
-
DEFAULT_CACHE_SIZE
protected static final int DEFAULT_CACHE_SIZE- See Also:
-
dbHandle
-
errHandler
-
changeMgr
-
schema
-
propertyTable
-
addrMap
-
name
-
cache
-
lock
-
-
Method Details
-
getTableName
-
getTableName
Get the default property table name for this property map.- Returns:
- default property map table name.
-
createTable
Create the default propertyTable. This method may be called by add property methods if propertyTable is null.- Parameters:
valueField
- property value field type- Throws:
IOException
- if IO error occurs
-
getName
Description copied from interface:PropertyMap
Get the name for this property map.- Specified by:
getName
in interfacePropertyMap<T>
- Returns:
- map name
-
setCacheSize
public void setCacheSize(int size) Adjust the size of the underlying read cache.- Parameters:
size
- the size of the cache.
-
delete
Delete this property map and all underlying tables. This method should be overidden if any table other than the default propertyTable is used.- Throws:
IOException
- if IO error occurs
-
intersects
Description copied from interface:PropertyMap
Given two addresses, indicate whether there is an address in that range (inclusive) having the property.- Specified by:
intersects
in interfacePropertyMap<T>
- Parameters:
startAddr
- the start of the range.endAddr
- the end of the range.- Returns:
- boolean true if at least one address in the range has the property, false otherwise.
-
intersects
Description copied from interface:PropertyMap
Indicate whether there is an address within the set which exists within this map.- Specified by:
intersects
in interfacePropertyMap<T>
- Parameters:
set
- set of addresses- Returns:
- boolean true if at least one address in the set has the property, false otherwise.
-
removeRange
Description copied from interface:PropertyMap
Removes all property values within a given range.- Specified by:
removeRange
in interfacePropertyMap<T>
- Parameters:
startAddr
- begin rangeendAddr
- end range, inclusive- Returns:
- true if any property value was removed; return false otherwise.
-
remove
Description copied from interface:PropertyMap
Remove the property value at the given address.- Specified by:
remove
in interfacePropertyMap<T>
- Parameters:
addr
- the address where the property should be removed- Returns:
- true if the property value was removed, false otherwise.
-
hasProperty
Description copied from interface:PropertyMap
returns whether there is a property value at addr.- Specified by:
hasProperty
in interfacePropertyMap<T>
- Parameters:
addr
- the address in question- Returns:
- true if map has value at specified address
-
getNextPropertyAddress
Description copied from interface:PropertyMap
Get the next address where the property value exists.- Specified by:
getNextPropertyAddress
in interfacePropertyMap<T>
- Parameters:
addr
- the address from which to begin the search (exclusive).- Returns:
- property value location after specified
addr
or null if none found
-
getPreviousPropertyAddress
Description copied from interface:PropertyMap
Get the previous Address where a property value exists.- Specified by:
getPreviousPropertyAddress
in interfacePropertyMap<T>
- Parameters:
addr
- the address from which to begin the search (exclusive).- Returns:
- property value location after specified
addr
or null if none found
-
getFirstPropertyAddress
Description copied from interface:PropertyMap
Get the first Address where a property value exists.- Specified by:
getFirstPropertyAddress
in interfacePropertyMap<T>
- Returns:
- first property value location or null if none found
-
getLastPropertyAddress
Description copied from interface:PropertyMap
Get the last Address where a property value exists.- Specified by:
getLastPropertyAddress
in interfacePropertyMap<T>
- Returns:
- last property value location or null if none found
-
getSize
public int getSize()Description copied from interface:PropertyMap
Get the number of properties in the map.- Specified by:
getSize
in interfacePropertyMap<T>
- Returns:
- number of stored property values
-
getAddressKeyIterator
public AddressKeyIterator getAddressKeyIterator(AddressSetView set, boolean atStart) throws IOException Get an iterator over the long address keys which contain a property value.- Parameters:
set
- addresses over which to iterate (null indicates all defined memory regions)atStart
- true if the iterator should be positioned at the start of the range- Returns:
- long address iterator.
- Throws:
IOException
- if IO error occurs
-
getAddressKeyIterator
Get an iterator over the long address keys which contain a property value.- Parameters:
start
- iterator starting positionbefore
- true if the iterator should be positioned before the start address- Returns:
- long address iterator.
- Throws:
IOException
- if IO error occurs
-
getAddressKeyIterator
public AddressKeyIterator getAddressKeyIterator(Address start, Address end, boolean atStart) throws IOException Get an iterator over the long address keys which contain a property value.- Parameters:
start
- start of iterator address rangeend
- end of iterator address rangeatStart
- true if the iterator should be positioned at the start of the range- Returns:
- long address iterator.
- Throws:
IOException
- if IO error occurs
-
getPropertyIterator
Description copied from interface:PropertyMap
Returns an iterator over the indices having a property value.- Specified by:
getPropertyIterator
in interfacePropertyMap<T>
- Parameters:
start
- minimum addressend
- maximum address- Returns:
- forward property address iterator
-
getPropertyIterator
Description copied from interface:PropertyMap
Returns an iterator over addresses that have a property value.- Specified by:
getPropertyIterator
in interfacePropertyMap<T>
- Parameters:
start
- minimum addressend
- maximum addressforward
- if true will iterate in increasing address order, otherwise it will start at the end and iterate in decreasing address order- Returns:
- property address iterator
-
getPropertyIterator
Description copied from interface:PropertyMap
Returns an iterator over the addresses that a property value.- Specified by:
getPropertyIterator
in interfacePropertyMap<T>
- Returns:
- forward property address iterator
-
getPropertyIterator
Description copied from interface:PropertyMap
Returns an iterator over the addresses that have a property value and are in the given address set.- Specified by:
getPropertyIterator
in interfacePropertyMap<T>
- Parameters:
asv
- the set of addresses to iterate over.- Returns:
- forward property address iterator
-
getPropertyIterator
Description copied from interface:PropertyMap
Returns an iterator over the addresses that have a property value and are in the given address set.- Specified by:
getPropertyIterator
in interfacePropertyMap<T>
- Parameters:
asv
- the set of addresses to iterate over.forward
- if true will iterate in increasing address order, otherwise it will start at the end and iterate in decreasing address order- Returns:
- property address iterator
-
getPropertyIterator
Description copied from interface:PropertyMap
Returns an iterator over the address having a property value.- Specified by:
getPropertyIterator
in interfacePropertyMap<T>
- Parameters:
start
- the starting addressforward
- if true will iterate in increasing address order, otherwise it will start at the end and iterate in decreasing address order- Returns:
- property address iterator
-
invalidateCache
public void invalidateCache()Invalidates the cache. -
moveRange
Description copied from interface:PropertyMap
Moves the properties defined in the range from the start address thru the end address to now be located beginning at the newStart address. The moved properties will be located at the same relative location to the newStart address as they were previously to the start address.- Specified by:
moveRange
in interfacePropertyMap<T>
- Parameters:
start
- the start of the range to move.end
- the end of the range to move.newStart
- the new start location of the range of properties after the move.
-