public class QuerySpaceTreePrinter extends Object
Prints a QuerySpaces
graph as a tree structure.
<p/>
Intended for use in debugging, logging, etc.
Modifier and Type | Field and Description |
---|---|
static QuerySpaceTreePrinter |
INSTANCE
Singleton access
|
Modifier and Type | Method and Description |
---|---|
String |
asString(QuerySpaces spaces,
AliasResolutionContext aliasResolutionContext)
Returns a String containing the
QuerySpaces graph as a tree structure. |
String |
asString(QuerySpaces spaces,
int depth,
AliasResolutionContext aliasResolutionContext)
Returns a String containing the
QuerySpaces graph as a tree structure, starting
at a particular depth. |
String |
extractDetails(QuerySpace space)
Returns a String containing high-level details about the
QuerySpace , such as:
<ul>
<li>query space class name</li>
<li>unique ID</li>
<li>entity name (for EntityQuerySpace </li>
<li>collection role (for CollectionQuerySpace </li> *
</ul> |
void |
write(QuerySpaces spaces,
int depth,
AliasResolutionContext aliasResolutionContext,
PrintStream printStream)
Returns a String containing the
QuerySpaces graph as a tree structure, starting
at a particular depth. |
void |
write(QuerySpaces spaces,
int depth,
AliasResolutionContext aliasResolutionContext,
PrintWriter printWriter)
Returns a String containing the
QuerySpaces graph as a tree structure, starting
at a particular depth. |
public static final QuerySpaceTreePrinter INSTANCE
Singleton access
public String asString(QuerySpaces spaces, AliasResolutionContext aliasResolutionContext)
Returns a String containing the QuerySpaces
graph as a tree structure.
spaces
- The QuerySpaces
object.aliasResolutionContext
- The context for resolving table and column aliases
for the QuerySpace
references in <code>spaces</code>; if null,
table and column aliases are not included in returned value..QuerySpaces
graph as a tree structure.public String asString(QuerySpaces spaces, int depth, AliasResolutionContext aliasResolutionContext)
Returns a String containing the QuerySpaces
graph as a tree structure, starting
at a particular depth.
The value for depth indicates the number of indentations that will prefix all lines in the returned String. Root query spaces will be written with depth + 1 and the depth will be further incremented as joined query spaces are traversed.
An indentation is defined as the number of characters defined by TreePrinterHelper.INDENTATION
.
spaces
- The QuerySpaces
object.depth
- The intial number of indentationsaliasResolutionContext
- The context for resolving table and column aliases
for the QuerySpace
references in <code>spaces</code>; if null,
table and column aliases are not included in returned value..QuerySpaces
graph as a tree structure.public void write(QuerySpaces spaces, int depth, AliasResolutionContext aliasResolutionContext, PrintStream printStream)
Returns a String containing the QuerySpaces
graph as a tree structure, starting
at a particular depth.
The value for depth indicates the number of indentations that will prefix all lines in the returned String. Root query spaces will be written with depth + 1 and the depth will be further incremented as joined query spaces are traversed.
An indentation is defined as the number of characters defined by TreePrinterHelper.INDENTATION
.
spaces
- The QuerySpaces
object.depth
- The intial number of indentationsaliasResolutionContext
- The context for resolving table and column aliases
for the QuerySpace
references in <code>spaces</code>; if null,
table and column aliases are not included in returned value.printStream
- The print stream for writing.public void write(QuerySpaces spaces, int depth, AliasResolutionContext aliasResolutionContext, PrintWriter printWriter)
Returns a String containing the QuerySpaces
graph as a tree structure, starting
at a particular depth.
The value for depth indicates the number of indentations that will prefix all lines in the returned String. Root query spaces will be written with depth + 1 and the depth will be further incremented as joined query spaces are traversed.
An indentation is defined as the number of characters defined by TreePrinterHelper.INDENTATION
.
spaces
- The QuerySpaces
object.depth
- The intial number of indentationsaliasResolutionContext
- The context for resolving table and column aliases
for the QuerySpace
references in <code>spaces</code>; if null,
table and column aliases are not included in returned value.printWriter
- The print writer for writing.public String extractDetails(QuerySpace space)
Returns a String containing high-level details about the QuerySpace
, such as:
<ul>
<li>query space class name</li>
<li>unique ID</li>
<li>entity name (for EntityQuerySpace
</li>
<li>collection role (for CollectionQuerySpace
</li> *
</ul>
space
- The query spaceQuerySpace
Copyright © 2001-2018 Red Hat, Inc. All Rights Reserved.