Package ghidra.program.database.properties

Class PropertyMapDB

java.lang.Object

ghidra.program.database.properties.PropertyMapDB

All Implemented Interfaces:

PropertyMap

Direct Known Subclasses:

IntPropertyMapDB, LongPropertyMapDB, ObjectPropertyMapDB, StringPropertyMapDB, UnsupportedMapDB, VoidPropertyMapDB

public abstract class PropertyMapDB
extends java.lang.Object
implements PropertyMap

Abstract class which defines a map containing properties over a set of addresses. The map is stored within a database table.

Field Summary

Fields

Modifier and Type	Field	Description
protected AddressMap	addrMap
protected ObjectCache	cache
protected ChangeManager	changeMgr
protected DBHandle	dbHandle
protected static int	DEFAULT_CACHE_SIZE
protected ErrorHandler	errHandler
protected Lock	lock
protected java.lang.String	name
protected static java.lang.String[]	NO_SCHEMA_FIELD_NAMES
protected static Field[]	NO_SCHEMA_FIELDS
protected static int	PROPERTY_VALUE_COL
protected Table	propertyTable
protected Schema	schema
protected static java.lang.String[]	SCHEMA_FIELD_NAMES

Method Summary

Modifier and Type	Method	Description
protected void	createTable(Field valueField)	Create the default propertyTable.
void	delete()	Delete this property map and all underlying tables.
AddressKeyIterator	getAddressKeyIterator(Address start, boolean before)	Get an iterator over the long address keys which contain a property value.
AddressKeyIterator	getAddressKeyIterator(Address start, Address end, boolean atStart)	Get an iterator over the long address keys which contain a property value.
AddressKeyIterator	getAddressKeyIterator(AddressSetView set, boolean atStart)	Get an iterator over the long address keys which contain a property value.
Address	getFirstPropertyAddress()	Get the first Address where a property value exists.
Address	getLastPropertyAddress()	Get the last Address where a property value exists.
java.lang.String	getName()	Get the name for this property map.
Address	getNextPropertyAddress(Address addr)	Get the next address where the property value exists.
Address	getPreviousPropertyAddress(Address addr)	Get the previous Address where a property value exists.
AddressIterator	getPropertyIterator()	Returns an iterator over the addresses that a property value.
AddressIterator	getPropertyIterator(Address start, boolean forward)	Returns an iterator over the address having a property value.
AddressIterator	getPropertyIterator(Address start, Address end)	Returns an iterator over the indices having a property value.
AddressIterator	getPropertyIterator(Address start, Address end, boolean forward)	Returns an iterator over addresses that have a property value.
AddressIterator	getPropertyIterator(AddressSetView asv)	Returns an iterator over the addresses that have a property value and are in the given address set.
AddressIterator	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 java.lang.String	getTableName()	Get the default property table name for this property map.
static java.lang.String	getTableName(java.lang.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	invalidateCache()	Invalidates the cache.
void	moveRange(Address start, Address end, Address newStart)	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(Address addr)	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

applyValue, getObject

Field Detail

SCHEMA_FIELD_NAMES

protected static final java.lang.String[] SCHEMA_FIELD_NAMES

NO_SCHEMA_FIELD_NAMES

protected static final java.lang.String[] NO_SCHEMA_FIELD_NAMES

NO_SCHEMA_FIELDS

protected static final Field[] NO_SCHEMA_FIELDS

PROPERTY_VALUE_COL

protected static final int PROPERTY_VALUE_COL

See Also:

Constant Field Values

DEFAULT_CACHE_SIZE

protected static final int DEFAULT_CACHE_SIZE

See Also:

Constant Field Values

dbHandle

protected DBHandle dbHandle

errHandler

protected ErrorHandler errHandler

changeMgr

protected ChangeManager changeMgr

schema

protected Schema schema

propertyTable

protected Table propertyTable

addrMap

protected AddressMap addrMap

name

protected java.lang.String name

cache

protected ObjectCache cache

lock

protected Lock lock

Method Detail

getTableName

public static java.lang.String getTableName(java.lang.String propertyName)

getTableName

protected java.lang.String getTableName()

Get the default property table name for this property map.

Returns:

default property map table name.

createTable

protected void createTable(Field valueField)
                    throws java.io.IOException

Create the default propertyTable. This method may be called by add property methods if propertyTable is null.

Throws:

java.io.IOException

getName

public java.lang.String getName()

Description copied from interface: PropertyMap

Get the name for this property map.

Specified by:

getName in interface PropertyMap

See Also:

PropertyMap.getName()

setCacheSize

public void setCacheSize(int size)

Adjust the size of the underlying read cache.

Parameters:

size - the size of the cache.

delete

public void delete()
            throws java.io.IOException

Delete this property map and all underlying tables. This method should be overidden if any table other than the default propertyTable is used.

Throws:

java.io.IOException

intersects

public boolean intersects(Address startAddr,
                          Address endAddr)

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 interface PropertyMap

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.

See Also:

PropertyMap.intersects(ghidra.program.model.address.Address, ghidra.program.model.address.Address)

intersects

public boolean intersects(AddressSetView set)

Description copied from interface: PropertyMap

Indicate whether there is an address within the set which exists within this map.

Specified by:

intersects in interface PropertyMap

Parameters:

set - set of addresses

Returns:

boolean true if at least one address in the set has the property, false otherwise.

See Also:

PropertyMap.intersects(ghidra.program.model.address.AddressSetView)

removeRange

public boolean removeRange(Address startAddr,
                           Address endAddr)

Description copied from interface: PropertyMap

Removes all property values within a given range.

Specified by:

removeRange in interface PropertyMap

Parameters:

startAddr - begin range

endAddr - end range, inclusive

Returns:

true if any property value was removed; return false otherwise.

See Also:

PropertyMap.removeRange(ghidra.program.model.address.Address, ghidra.program.model.address.Address)

remove

public boolean remove(Address addr)

Description copied from interface: PropertyMap

Remove the property value at the given address.

Specified by:

remove in interface PropertyMap

Parameters:

addr - the address where the property should be removed

Returns:

true if the property value was removed, false otherwise.

See Also:

PropertyMap.remove(ghidra.program.model.address.Address)

hasProperty

public boolean hasProperty(Address addr)

Description copied from interface: PropertyMap

returns whether there is a property value at addr.

Specified by:

hasProperty in interface PropertyMap

Parameters:

addr - the address in question

See Also:

PropertyMap.hasProperty(ghidra.program.model.address.Address)

getNextPropertyAddress

public Address getNextPropertyAddress(Address addr)

Description copied from interface: PropertyMap

Get the next address where the property value exists.

Specified by:

getNextPropertyAddress in interface PropertyMap

Parameters:

addr - the address from which to begin the search (exclusive).

See Also:

PropertyMap.getNextPropertyAddress(ghidra.program.model.address.Address)

getPreviousPropertyAddress

public Address getPreviousPropertyAddress(Address addr)

Description copied from interface: PropertyMap

Get the previous Address where a property value exists.

Specified by:

getPreviousPropertyAddress in interface PropertyMap

Parameters:

addr - the address from which to begin the search (exclusive).

See Also:

PropertyMap.getPreviousPropertyAddress(ghidra.program.model.address.Address)

getFirstPropertyAddress

public Address getFirstPropertyAddress()

Description copied from interface: PropertyMap

Get the first Address where a property value exists.

Specified by:

getFirstPropertyAddress in interface PropertyMap

See Also:

PropertyMap.getFirstPropertyAddress()

getLastPropertyAddress

public Address getLastPropertyAddress()

Description copied from interface: PropertyMap

Get the last Address where a property value exists.

Specified by:

getLastPropertyAddress in interface PropertyMap

See Also:

PropertyMap.getLastPropertyAddress()

getSize

public int getSize()

Description copied from interface: PropertyMap

Get the number of properties in the map.

Specified by:

getSize in interface PropertyMap

See Also:

PropertyMap.getSize()

getAddressKeyIterator

public AddressKeyIterator getAddressKeyIterator(AddressSetView set,
                                                boolean atStart)
                                         throws java.io.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:

java.io.IOException

getAddressKeyIterator

public AddressKeyIterator getAddressKeyIterator(Address start,
                                                boolean before)
                                         throws java.io.IOException

Get an iterator over the long address keys which contain a property value.

Parameters:

start -

before - true if the iterator should be positioned before the start address

Returns:

long address iterator.

Throws:

java.io.IOException

getAddressKeyIterator

public AddressKeyIterator getAddressKeyIterator(Address start,
                                                Address end,
                                                boolean atStart)
                                         throws java.io.IOException

Get an iterator over the long address keys which contain a property value.

Parameters:

start -

end -

atStart - true if the iterator should be positioned at the start of the range

Returns:

long address iterator.

Throws:

java.io.IOException

getPropertyIterator

public AddressIterator getPropertyIterator(Address start,
                                           Address end)

Description copied from interface: PropertyMap

Returns an iterator over the indices having a property value.

Specified by:

getPropertyIterator in interface PropertyMap

See Also:

PropertyMap.getPropertyIterator(ghidra.program.model.address.Address, ghidra.program.model.address.Address)

getPropertyIterator

public AddressIterator getPropertyIterator(Address start,
                                           Address end,
                                           boolean forward)

Description copied from interface: PropertyMap

Returns an iterator over addresses that have a property value.

Specified by:

getPropertyIterator in interface PropertyMap

forward - if true will iterate in increasing address order, otherwise it will start at the end and iterate in decreasing address order

See Also:

PropertyMap.getPropertyIterator(ghidra.program.model.address.Address, ghidra.program.model.address.Address, boolean)

getPropertyIterator

public AddressIterator getPropertyIterator()

Description copied from interface: PropertyMap

Returns an iterator over the addresses that a property value.

Specified by:

getPropertyIterator in interface PropertyMap

See Also:

PropertyMap.getPropertyIterator()

getPropertyIterator

public AddressIterator getPropertyIterator(AddressSetView asv)

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 interface PropertyMap

Parameters:

asv - the set of addresses to iterate over.

See Also:

PropertyMap.getPropertyIterator(ghidra.program.model.address.AddressSetView)

getPropertyIterator

public AddressIterator getPropertyIterator(AddressSetView asv,
                                           boolean forward)

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 interface PropertyMap

forward - if true will iterate in increasing address order, otherwise it will start at the end and iterate in decreasing address order

See Also:

PropertyMap.getPropertyIterator(ghidra.program.model.address.AddressSetView, boolean)

getPropertyIterator

public AddressIterator getPropertyIterator(Address start,
                                           boolean forward)

Description copied from interface: PropertyMap

Returns an iterator over the address having a property value.

Specified by:

getPropertyIterator in interface PropertyMap

Parameters:

start - the starting address

forward - if true will iterate in increasing address order, otherwise it will start at the end and iterate in decreasing address order

See Also:

PropertyMap.getPropertyIterator(ghidra.program.model.address.Address, boolean)

invalidateCache

public void invalidateCache()

Invalidates the cache.

moveRange

public void moveRange(Address start,
                      Address end,
                      Address newStart)

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 interface PropertyMap

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.

See Also:

PropertyMap.moveRange(ghidra.program.model.address.Address, ghidra.program.model.address.Address, ghidra.program.model.address.Address)