Package ghidra.trace.database.bookmark

Class DBTraceBookmark

java.lang.Object

ghidra.program.database.DatabaseObject

ghidra.util.database.DBAnnotatedObject

ghidra.util.database.spatial.DBTreeRecord<TraceAddressSnapRange,TraceAddressSnapRange>

ghidra.util.database.spatial.DBTreeDataRecord<TraceAddressSnapRange,TraceAddressSnapRange,DBTraceBookmark>

ghidra.trace.database.map.DBTraceAddressSnapRangePropertyMapTree.AbstractDBTraceAddressSnapRangePropertyMapData<DBTraceBookmark>

ghidra.trace.database.bookmark.DBTraceBookmark

All Implemented Interfaces:

Bookmark, TraceBookmark, TraceAddressSnapRange, BoundedShape<TraceAddressSnapRange>, BoundingShape<TraceAddressSnapRange>, Rectangle2D<Address,Long,TraceAddressSnapRange>, Comparable<Bookmark>

public class DBTraceBookmark
extends DBTraceAddressSnapRangePropertyMapTree.AbstractDBTraceAddressSnapRangePropertyMapData<DBTraceBookmark>
implements TraceBookmark

Nested Class Summary

Nested classes/interfaces inherited from class ghidra.util.database.spatial.DBTreeDataRecord

DBTreeDataRecord.RecordEntry<DS extends BoundedShape<NS>,NS extends BoundingShape<NS>,T>

Field Summary

Fields

Modifier and Type	Field	Description
protected final DBTraceBookmarkSpace	space
protected static final String	TABLE_NAME

Fields inherited from class ghidra.trace.database.map.DBTraceAddressSnapRangePropertyMapTree.AbstractDBTraceAddressSnapRangePropertyMapData

lifespan, range, tree

Fields inherited from class ghidra.program.database.DatabaseObject

key

Constructor Summary

Constructors

Constructor	Description
DBTraceBookmark(DBTraceBookmarkSpace space, DBTraceAddressSnapRangePropertyMapTree<DBTraceBookmark,?> tree, DBCachedObjectStore<?> store, DBRecord record)

Method Summary

Modifier and Type	Method	Description
int	compareTo(Bookmark o)
void	delete()
Address	getAddress()	Returns address at which this bookmark is applied.
String	getCategory()	Returns bookmark category
String	getComment()	Returns bookmark comment
long	getId()	Returns the id of the bookmark.
protected DBTraceBookmark	getRecordValue()	Get the value of this record Note that the value is sometimes the record itself, i.e., this method returns this.
TraceThread	getThread()	If this bookmark is in a register space, identifies the containing thread
DBTrace	getTrace()
TraceBookmarkType	getType()	Returns bookmark type object.
String	getTypeString()	Returns bookmark type as a string
void	set(String category, String comment)	Set the category and comment associated with a bookmark.
void	setLifespan(Lifespan lifespan)
protected void	setRecordValue(DBTraceBookmark value)	Set the value of this record Note that the value is sometimes the record itself.
String	toString()

Methods inherited from class ghidra.trace.database.map.DBTraceAddressSnapRangePropertyMapTree.AbstractDBTraceAddressSnapRangePropertyMapData

doSetLifespan, doSetRange, equals, fresh, getBounds, getLifespan, getParentKey, getRange, getShape, getSpace, hashCode, setParentKey, setShape, shapeEquals

Methods inherited from class ghidra.util.database.spatial.DBTreeDataRecord

asEntry, getDataCount

Methods inherited from class ghidra.util.database.DBAnnotatedObject

doRefresh, doUpdateAll, doUpdated, doWrite, getObjectKey, getTableName, isDeleted, refresh, refresh, update, update, update, update

Methods inherited from class ghidra.program.database.DatabaseObject

checkDeleted, checkIsValid, checkIsValid, getKey, isDeleted, isInvalid, keyChanged, setDeleted, setInvalid, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ghidra.util.database.spatial.rect.Rectangle2D

computeAreaIntersection, computeAreaUnionBounds, computeCentroidDistance, contains, contains, doEquals, doHashCode, enclosedBy, encloses, getArea, getCenter, getMargin, intersection, intersects, unionBounds

Methods inherited from interface ghidra.trace.model.TraceAddressSnapRange

description, getX1, getX2, getY1, getY2, immutable

Methods inherited from interface ghidra.trace.model.bookmark.TraceBookmark

getLifespan

Field Details

TABLE_NAME

protected static final String TABLE_NAME

See Also:

• Constant Field Values

space

protected final DBTraceBookmarkSpace space

Constructor Details

DBTraceBookmark

public DBTraceBookmark(DBTraceBookmarkSpace space,
 DBTraceAddressSnapRangePropertyMapTree<DBTraceBookmark,?> tree,
 DBCachedObjectStore<?> store,
 DBRecord record)

Method Details

setRecordValue

protected void setRecordValue(DBTraceBookmark value)

Description copied from class: DBTreeDataRecord

Set the value of this record Note that the value is sometimes the record itself. In this case, this method expects value to be null and does nothing. See SpatialMap.put(BoundedShape, Object) for more details of this pattern.

Specified by:

setRecordValue in class DBTreeDataRecord<TraceAddressSnapRange,TraceAddressSnapRange,DBTraceBookmark>

Parameters:

value - the record's new value

getRecordValue

protected DBTraceBookmark getRecordValue()

Description copied from class: DBTreeDataRecord

Get the value of this record Note that the value is sometimes the record itself, i.e., this method returns this. See SpatialMap.put(BoundedShape, Object) for more details of this pattern.

Specified by:

getRecordValue in class DBTreeDataRecord<TraceAddressSnapRange,TraceAddressSnapRange,DBTraceBookmark>

Returns:

the record's value

setLifespan

public void setLifespan(Lifespan lifespan)

Specified by:

setLifespan in interface TraceBookmark

getTrace

public DBTrace getTrace()

Specified by:

getTrace in interface TraceBookmark

getThread

public TraceThread getThread()

Description copied from interface: TraceBookmark

If this bookmark is in a register space, identifies the containing thread

Specified by:

getThread in interface TraceBookmark

Returns:

the thread, or null if this bookmark is not in register space

getId

public long getId()

Description copied from interface: Bookmark

Returns the id of the bookmark.

Specified by:

getId in interface Bookmark

getAddress

public Address getAddress()

Description copied from interface: Bookmark

Returns address at which this bookmark is applied.

Specified by:

getAddress in interface Bookmark

getType

public TraceBookmarkType getType()

Description copied from interface: Bookmark

Returns bookmark type object.

Specified by:

getType in interface Bookmark

Specified by:

getType in interface TraceBookmark

getTypeString

public String getTypeString()

Description copied from interface: Bookmark

Returns bookmark type as a string

Specified by:

getTypeString in interface Bookmark

getCategory

public String getCategory()

Description copied from interface: Bookmark

Returns bookmark category

Specified by:

getCategory in interface Bookmark

getComment

public String getComment()

Description copied from interface: Bookmark

Returns bookmark comment

Specified by:

getComment in interface Bookmark

set

public void set(String category,
 String comment)

Description copied from interface: Bookmark

Set the category and comment associated with a bookmark.

Specified by:

set in interface Bookmark

Parameters:

category - category

comment - single line comment

delete

public void delete()

Specified by:

delete in interface TraceBookmark

compareTo

public int compareTo(Bookmark o)

Specified by:

compareTo in interface Comparable<Bookmark>

toString

public String toString()

Overrides:

toString in class DBTreeDataRecord<TraceAddressSnapRange,TraceAddressSnapRange,DBTraceBookmark>