StringPrintContext (TopBraid SHACL API 1.0.1 API)

java.lang.Object
- org.topbraid.spin.model.print.StringPrintContext

All Implemented Interfaces:

PrintContext
```
public class StringPrintContext
extends Object
implements PrintContext
```
A simple implementation of PrintContext that operates on a StringBuilder. By default this is using prefixes but not extra prefixes.

Author:

Holger Knublauch

Field Summary

Fields
Modifier and Type Field and Description

protected String indentationString

Fields
Modifier and Type	Field and Description
`protected String`	`indentationString`

Constructor Summary

Constructors
Constructor and Description
`StringPrintContext()`
`StringPrintContext(StringBuilder sb)`
`StringPrintContext(StringBuilder sb, Map<String,org.apache.jena.rdf.model.RDFNode> initialBindings)`

Method Summary

All Methods Static Methods Instance Methods Concrete 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.
`String`	`getString()`
`StringBuilder`	`getStringBuilder()`
`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.
`static String`	`qnameFor(org.apache.jena.rdf.model.Resource resource)` Work-around for a bug in Jena: Jena would use the default namespace of an imported Graph in a MultiUnion.
`void`	`setIndentation(int value)` Changes the indentation level.
`void`	`setIndentationString(String value)`
`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.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - indentationString
```
protected String indentationString
```
- Constructor Detail
  - StringPrintContext
```
public StringPrintContext()
```
  - StringPrintContext
```
public StringPrintContext(StringBuilder sb)
```
  - StringPrintContext
```
public StringPrintContext(StringBuilder sb,
                          Map<String,org.apache.jena.rdf.model.RDFNode> initialBindings)
```
- Method Detail
  - clone
```
public PrintContext clone()
```
    Description copied from interface: PrintContext
    
    Creates a clone of this PrintContext so that it can be used recursively.
    
    Specified by:
    
    clone in interface PrintContext
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    a clone
  - getIndentation
```
public int getIndentation()
```
    Description copied from interface: PrintContext
    
    Gets the indentation level starting at 0. Indentation increases in element groups.
    
    Specified by:
    
    getIndentation in interface PrintContext
    
    Returns:
    
    the indentation level
    
    See Also:
    
    PrintContext.setIndentation(int)
  - getInitialBinding
```
public org.apache.jena.rdf.model.RDFNode getInitialBinding(String varName)
```
    Description copied from interface: PrintContext
    
    Gets an initial binding for a variable, so that a constant will be inserted into the query string instead of the variable name.
    
    Specified by:
    
    getInitialBinding in interface PrintContext
    
    Parameters:
    
    varName - the name of the variable to match
    
    Returns:
    
    a literal or URI resource, or null
  - getNodeToLabelMap
```
public org.apache.jena.sparql.util.NodeToLabelMap getNodeToLabelMap()
```
    Description copied from interface: PrintContext
    
    Gets the Jena NodeToLabelMap associated with this.
    
    Specified by:
    
    getNodeToLabelMap in interface PrintContext
    
    Returns:
    
    the NodeToLabelMap
  - getPrintPrefixes
```
public boolean getPrintPrefixes()
```
    Description copied from interface: PrintContext
    
    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.
    
    Specified by:
    
    getPrintPrefixes in interface PrintContext
    
    Returns:
    
    true to print prefixes
  - getString
```
public String getString()
```
  - getStringBuilder
```
public StringBuilder getStringBuilder()
```
  - getUseExtraPrefixes
```
public boolean getUseExtraPrefixes()
```
    Description copied from interface: PrintContext
    
    Checks if the extra prefixes (such as afn:) shall be used to resolve qnames, even if they are not imported by the current model.
    
    Specified by:
    
    getUseExtraPrefixes in interface PrintContext
    
    Returns:
    
    true if the extra prefixes shall be used
    
    See Also:
    
    PrintContext.setUseExtraPrefixes(boolean)
  - getUsePrefixes
```
public boolean getUsePrefixes()
```
    Description copied from interface: PrintContext
    
    Checks if resource URIs shall be abbreviated with qnames at all. If not, then the URIs are rendered using the <...> notation.
    
    Specified by:
    
    getUsePrefixes in interface PrintContext
    
    Returns:
    
    true if this is using prefixes
  - hasInitialBindings
```
public boolean hasInitialBindings()
```
    Description copied from interface: PrintContext
    
    Checks whether any initial bindings have been declared for this context.
    
    Specified by:
    
    hasInitialBindings in interface PrintContext
    
    Returns:
    
    true if bindings of at least one variable exist
  - isNamedBNodeMode
```
public boolean isNamedBNodeMode()
```
    Description copied from interface: PrintContext
    
    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.
    
    Specified by:
    
    isNamedBNodeMode in interface PrintContext
    
    Returns:
    
    true if bnodes shall be rendered as named variables
  - isNested
```
public boolean isNested()
```
    Description copied from interface: PrintContext
    
    Checks if we are inside braces such as a nested expression.
    
    Specified by:
    
    isNested in interface PrintContext
    
    Returns:
    
    if the context is currently in nested mode
  - print
```
public void print(String str)
```
    Description copied from interface: PrintContext
    
    Prints a given string to the output stream.
    
    Specified by:
    
    print in interface PrintContext
    
    Parameters:
    
    str - Non-null string.
  - printIndentation
```
public void printIndentation(int depth)
```
    Description copied from interface: PrintContext
    
    Prints the indentation string depth times. For example, for depth=2 this might print " ".
    
    Specified by:
    
    printIndentation in interface PrintContext
    
    Parameters:
    
    depth - the number of indentations to print
  - printKeyword
```
public void printKeyword(String str)
```
    Description copied from interface: PrintContext
    
    Prints a keyword to the output stream. This can be overloaded by subclasses to do special rendering such as syntax highlighting.
    
    Specified by:
    
    printKeyword in interface PrintContext
    
    Parameters:
    
    str - the keyword string
  - println
```
public void println()
```
    Description copied from interface: PrintContext
    
    Prints a line break to the output stream. Typically this would be a /n but implementations may also do
    .
    
    Specified by:
    
    println in interface PrintContext
  - printVariable
```
public void printVariable(String str)
```
    Description copied from interface: PrintContext
    
    Prints a variable to the output stream. This can be overloaded by subclasses to do special rendering such as syntax highlighting.
    
    Specified by:
    
    printVariable in interface PrintContext
    
    Parameters:
    
    str - the variable string excluding the ?
  - printURIResource
```
public void printURIResource(org.apache.jena.rdf.model.Resource resource)
```
    Description copied from interface: PrintContext
    
    Prints a URI to the output stream. This can be overloaded by subclasses to do special rendering such as syntax highlighting.
    
    Specified by:
    
    printURIResource in interface PrintContext
    
    Parameters:
    
    resource - the URI of the resource to print
  - qnameFor
```
public static String qnameFor(org.apache.jena.rdf.model.Resource resource)
```
    Work-around for a bug in Jena: Jena would use the default namespace of an imported Graph in a MultiUnion.
    
    Parameters:
    
    resource - the Resource to get the qname for
    
    Returns:
    
    the qname or null
  - setIndentation
```
public void setIndentation(int value)
```
    Description copied from interface: PrintContext
    
    Changes the indentation level.
    
    Specified by:
    
    setIndentation in interface PrintContext
    
    Parameters:
    
    value - the new indentation level
  - setIndentationString
```
public void setIndentationString(String value)
```
  - setNamedBNodeMode
```
public void setNamedBNodeMode(boolean value)
```
    Description copied from interface: PrintContext
    
    Activates or deactivates the mode in which bnodes are rendered as named variables, such as _:b0.
    
    Specified by:
    
    setNamedBNodeMode in interface PrintContext
    
    Parameters:
    
    value - true to activate, false to deactivate
  - setNested
```
public void setNested(boolean value)
```
    Description copied from interface: PrintContext
    
    Sets the nested flag.
    
    Specified by:
    
    setNested in interface PrintContext
    
    Parameters:
    
    value - the new value
    
    See Also:
    
    PrintContext.isNested()
  - setPrintPrefixes
```
public void setPrintPrefixes(boolean value)
```
    Description copied from interface: PrintContext
    
    Sets the printPrefixes flag.
    
    Specified by:
    
    setPrintPrefixes in interface PrintContext
    
    Parameters:
    
    value - the new value
    
    See Also:
    
    PrintContext.getPrintPrefixes()
  - setUseExtraPrefixes
```
public void setUseExtraPrefixes(boolean value)
```
    Description copied from interface: PrintContext
    
    Specifies whether the context shall use extra prefixes.
    
    Specified by:
    
    setUseExtraPrefixes in interface PrintContext
    
    Parameters:
    
    value - the new value
    
    See Also:
    
    PrintContext.getUseExtraPrefixes()
  - setUsePrefixes
```
public void setUsePrefixes(boolean value)
```
    Description copied from interface: PrintContext
    
    Specifies whether the context shall use any prefixes at all.
    
    Specified by:
    
    setUsePrefixes in interface PrintContext
    
    Parameters:
    
    value - the new value
    
    See Also:
    
    PrintContext.getUsePrefixes()

Class StringPrintContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

indentationString

Constructor Detail

StringPrintContext

StringPrintContext

StringPrintContext

Method Detail

clone

getIndentation

getInitialBinding

getNodeToLabelMap

getPrintPrefixes

getString

getStringBuilder

getUseExtraPrefixes

getUsePrefixes

hasInitialBindings

isNamedBNodeMode

isNested

print

printIndentation

printKeyword

println

printVariable

printURIResource

qnameFor

setIndentation

setIndentationString

setNamedBNodeMode

setNested

setPrintPrefixes

setUseExtraPrefixes

setUsePrefixes