PrintContext (TopBraid SHACL API 1.0.1 API)

All Known Implementing Classes:

StringPrintContext
```
public interface PrintContext
```
A status object passed along during printing of SPIN expressions in SPARQL syntax.

Author:

Holger Knublauch

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`PrintContext`	`clone()` Creates a clone of this PrintContext so that it can be used recursively.
`int`	`getIndentation()` Gets the indentation level starting at 0.
`org.apache.jena.rdf.model.RDFNode`	`getInitialBinding(String varName)` Gets an initial binding for a variable, so that a constant will be inserted into the query string instead of the variable name.
`org.apache.jena.sparql.util.NodeToLabelMap`	`getNodeToLabelMap()` Gets the Jena NodeToLabelMap associated with this.
`boolean`	`getPrintPrefixes()` Checks whether prefix declarations shall be printed into the head of the query.
`boolean`	`getUseExtraPrefixes()` Checks if the extra prefixes (such as afn:) shall be used to resolve qnames, even if they are not imported by the current model.
`boolean`	`getUsePrefixes()` Checks if resource URIs shall be abbreviated with qnames at all.
`boolean`	`hasInitialBindings()` Checks whether any initial bindings have been declared for this context.
`boolean`	`isNamedBNodeMode()` Checks if we are inside of a mode (such as INSERT { GRAPH { ...
`boolean`	`isNested()` Checks if we are inside braces such as a nested expression.
`void`	`print(String str)` Prints a given string to the output stream.
`void`	`printIndentation(int depth)` Prints the indentation string depth times.
`void`	`printKeyword(String str)` Prints a keyword to the output stream.
`void`	`println()` Prints a line break to the output stream.
`void`	`printURIResource(org.apache.jena.rdf.model.Resource resource)` Prints a URI to the output stream.
`void`	`printVariable(String str)` Prints a variable to the output stream.
`void`	`setIndentation(int value)` Changes the indentation level.
`void`	`setNamedBNodeMode(boolean value)` Activates or deactivates the mode in which bnodes are rendered as named variables, such as _:b0.
`void`	`setNested(boolean value)` Sets the nested flag.
`void`	`setPrintPrefixes(boolean value)` Sets the printPrefixes flag.
`void`	`setUseExtraPrefixes(boolean value)` Specifies whether the context shall use extra prefixes.
`void`	`setUsePrefixes(boolean value)` Specifies whether the context shall use any prefixes at all.

- Method Detail
  - clone
```
PrintContext clone()
```
    Creates a clone of this PrintContext so that it can be used recursively.
    
    Returns:
    
    a clone
  - getIndentation
```
int getIndentation()
```
    Gets the indentation level starting at 0. Indentation increases in element groups.
    
    Returns:
    
    the indentation level
    
    See Also:
    
    setIndentation(int)
  - getInitialBinding
```
org.apache.jena.rdf.model.RDFNode getInitialBinding(String varName)
```
    Gets an initial binding for a variable, so that a constant will be inserted into the query string instead of the variable name.
    
    Parameters:
    
    varName - the name of the variable to match
    
    Returns:
    
    a literal or URI resource, or null
  - getNodeToLabelMap
```
org.apache.jena.sparql.util.NodeToLabelMap getNodeToLabelMap()
```
    Gets the Jena NodeToLabelMap associated with this.
    
    Returns:
    
    the NodeToLabelMap
  - getPrintPrefixes
```
boolean getPrintPrefixes()
```
    Checks whether prefix declarations shall be printed into the head of the query. By default this is switched off, but if turned on then the system should print all used prefixes.
    
    Returns:
    
    true to print prefixes
  - getUseExtraPrefixes
```
boolean getUseExtraPrefixes()
```
    Checks if the extra prefixes (such as afn:) shall be used to resolve qnames, even if they are not imported by the current model.
    
    Returns:
    
    true if the extra prefixes shall be used
    
    See Also:
    
    setUseExtraPrefixes(boolean)
  - getUsePrefixes
```
boolean getUsePrefixes()
```
    Checks if resource URIs shall be abbreviated with qnames at all. If not, then the URIs are rendered using the <...> notation.
    
    Returns:
    
    true if this is using prefixes
  - hasInitialBindings
```
boolean hasInitialBindings()
```
    Checks whether any initial bindings have been declared for this context.
    
    Returns:
    
    true if bindings of at least one variable exist
  - isNamedBNodeMode
```
boolean isNamedBNodeMode()
```
    Checks if we are inside of a mode (such as INSERT { GRAPH { ... } } or CONSTRUCT { ... } in which blank nodes shall be mapped to named variables such as _:b0. This can be set temporarily using the corresponding setter but needs to be reset when done by the surrounding block.
    
    Returns:
    
    true if bnodes shall be rendered as named variables
  - isNested
```
boolean isNested()
```
    Checks if we are inside braces such as a nested expression.
    
    Returns:
    
    if the context is currently in nested mode
  - print
```
void print(String str)
```
    Prints a given string to the output stream.
    
    Parameters:
    
    str - the String to print
  - printIndentation
```
void printIndentation(int depth)
```
    Prints the indentation string depth times. For example, for depth=2 this might print " ".
    
    Parameters:
    
    depth - the number of indentations to print
  - printKeyword
```
void printKeyword(String str)
```
    Prints a keyword to the output stream. This can be overloaded by subclasses to do special rendering such as syntax highlighting.
    
    Parameters:
    
    str - the keyword string
  - println
```
void println()
```
    Prints a line break to the output stream. Typically this would be a /n but implementations may also do
    .
  - printURIResource
```
void printURIResource(org.apache.jena.rdf.model.Resource resource)
```
    Prints a URI to the output stream. This can be overloaded by subclasses to do special rendering such as syntax highlighting.
    
    Parameters:
    
    resource - the URI of the resource to print
  - printVariable
```
void printVariable(String str)
```
    Prints a variable to the output stream. This can be overloaded by subclasses to do special rendering such as syntax highlighting.
    
    Parameters:
    
    str - the variable string excluding the ?
  - setIndentation
```
void setIndentation(int value)
```
    Changes the indentation level.
    
    Parameters:
    
    value - the new indentation level
  - setNamedBNodeMode
```
void setNamedBNodeMode(boolean value)
```
    Activates or deactivates the mode in which bnodes are rendered as named variables, such as _:b0.
    
    Parameters:
    
    value - true to activate, false to deactivate
  - setNested
```
void setNested(boolean value)
```
    Sets the nested flag.
    
    Parameters:
    
    value - the new value
    
    See Also:
    
    isNested()
  - setPrintPrefixes
```
void setPrintPrefixes(boolean value)
```
    Sets the printPrefixes flag.
    
    Parameters:
    
    value - the new value
    
    See Also:
    
    getPrintPrefixes()
  - setUseExtraPrefixes
```
void setUseExtraPrefixes(boolean value)
```
    Specifies whether the context shall use extra prefixes.
    
    Parameters:
    
    value - the new value
    
    See Also:
    
    getUseExtraPrefixes()
  - setUsePrefixes
```
void setUsePrefixes(boolean value)
```
    Specifies whether the context shall use any prefixes at all.
    
    Parameters:
    
    value - the new value
    
    See Also:
    
    getUsePrefixes()

Interface PrintContext

Method Summary

Method Detail

clone

getIndentation

getInitialBinding

getNodeToLabelMap

getPrintPrefixes

getUseExtraPrefixes

getUsePrefixes

hasInitialBindings

isNamedBNodeMode

isNested

print

printIndentation

printKeyword

println

printURIResource

printVariable

setIndentation

setNamedBNodeMode

setNested

setPrintPrefixes

setUseExtraPrefixes

setUsePrefixes