|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IQueryContext
The context for a query. Hides the snapshot implementation, and is not tied to the snapshot API.
Method Summary | |
---|---|
boolean |
available(java.lang.Class<?> type,
Argument.Advice advice)
Is this type of data available from the context? |
boolean |
converts(java.lang.Class<?> type,
Argument.Advice advice)
Does the context have a converter for data of this type? |
java.lang.String |
convertToString(java.lang.Class<?> type,
Argument.Advice advice,
java.lang.Object value)
Convert the value to a string. |
java.lang.Object |
convertToValue(java.lang.Class<?> type,
Argument.Advice advice,
java.lang.String value)
Convert the String to the value based on the type and advice. |
java.lang.Object |
get(java.lang.Class<?> type,
Argument.Advice advice)
Get this type of data from the context. |
ContextDerivedData |
getContextDerivedData()
For example, retained size derived data. |
java.io.File |
getPrimaryFile()
The main file for the snapshot |
java.lang.String |
mapToExternalIdentifier(int objectId)
Map an id to a readable form. |
int |
mapToObjectId(java.lang.String externalIdentifier)
Map readable form to internal id. |
java.lang.Object |
parse(java.lang.Class<?> type,
Argument.Advice advice,
java.lang.String[] args,
java.text.ParsePosition pos)
Consume the special data. |
boolean |
parses(java.lang.Class<?> type,
Argument.Advice advice)
Is special parsing required to get an object of the required type? |
Method Detail |
---|
java.io.File getPrimaryFile()
boolean available(java.lang.Class<?> type, Argument.Advice advice)
type
- the type the data should be converted toadvice
- advice such as from the query as to how the value should be converted.
java.lang.Object get(java.lang.Class<?> type, Argument.Advice advice)
type
- the type the data should be converted toadvice
- advice such as from the query as to how the value should be converted.
java.lang.String mapToExternalIdentifier(int objectId) throws SnapshotException
mapToObjectId(java.lang.String)
objectId
-
SnapshotException
mapToObjectId(java.lang.String)
int mapToObjectId(java.lang.String externalIdentifier) throws SnapshotException
mapToExternalIdentifier(int)
externalIdentifier
-
SnapshotException
boolean converts(java.lang.Class<?> type, Argument.Advice advice)
type
- advice
-
java.lang.String convertToString(java.lang.Class<?> type, Argument.Advice advice, java.lang.Object value) throws SnapshotException
type
- advice
- value
-
SnapshotException
java.lang.Object convertToValue(java.lang.Class<?> type, Argument.Advice advice, java.lang.String value) throws SnapshotException
type
- advice
- value
-
SnapshotException
boolean parses(java.lang.Class<?> type, Argument.Advice advice)
type
- advice
-
java.lang.Object parse(java.lang.Class<?> type, Argument.Advice advice, java.lang.String[] args, java.text.ParsePosition pos) throws SnapshotException
type
- advice
- args
- pos
-
SnapshotException
ContextDerivedData getContextDerivedData()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |