CompileOptions (pso-schematron 2.0.0 API)

java.lang.Object
- org.pageseeder.schematron.CompileOptions

```
public final class CompileOptions
extends java.lang.Object
```
Available options for compiling Schematron.
Compile options must be supplied to the Schematron compiler and affect the generated validator.

This class uses a fluent style and instances are immutable so that options can be reused without side-effects.
Unless specified, Schematron uses the defaults() method.

For backward-compatibility with the previous version of this library, the defaults can be overriden to use behave like the previous version. To run in compatibility mode, set the system property org.pageseeder.schematron.compatibility to "1.0".

Since:

2.0

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CompileOptions`	`compact(boolean compact)` The latest version all.
`java.lang.String`	`defaultQueryBinding()` Indicates which query binding to use if not specified in the Schema.
`CompileOptions`	`defaultQueryBinding(java.lang.String defaultQueryBinding)` Schematron assumes `xslt` by default, but this method allows you to change this.
`static CompileOptions`	`defaults()` The default compile options.
`boolean`	`equals(java.lang.Object o)`
`int`	`hashCode()`
`boolean`	`hasMetadata()` Indicates whether to include the `` element in the SVRL output
`boolean`	`isCompact()` Indicates whether to only generate the compact SVRL output
`boolean`	`isStreamable()`
`CompileOptions`	`metadata(boolean metadata)` Whether to generate and include the `` element in the SVRL output.
`CompileOptions`	`streamable(boolean streamable)` Set whether the source is streamble.
`java.util.Map<java.lang.String,java.lang.Object>`	`toParameters()`
`java.util.Map<java.lang.String,java.lang.Object>`	`toParameters(java.lang.String phase)` Returns a new mutable parameter map containing the parameters corresponding to these options.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - defaults
```
public static CompileOptions defaults()
```
    The default compile options.
    They are:
    - defaultQueryBinding = "xslt"
    - metadata = false
    - streamable = false
    - compact = false
    In compatibility mode, defaultQueryBinding = "xslt2"
    Returns:
    
    the default compile options for Schematron.
  - defaultQueryBinding
```
public CompileOptions defaultQueryBinding(java.lang.String defaultQueryBinding)
```
    Schematron assumes `xslt` by default, but this method allows you to change this.
    
    Parameters:
    
    defaultQueryBinding - The query binding to use if not specified in the Schema.
    
    Returns:
    
    A new instance using the specified option.
  - metadata
```
public CompileOptions metadata(boolean metadata)
```
    Whether to generate and include the `` element in the SVRL output.
    
    Parameters:
    
    metadata - The Schematron metadata.
    
    Returns:
    
    A new instance using the specified option.
  - streamable
```
public CompileOptions streamable(boolean streamable)
```
    Set whether the source is streamble.
    
    Returns:
    
    A new instance using the specified option.
  - compact
```
public CompileOptions compact(boolean compact)
```
    The latest version all.
    
    Returns:
    
    A new instance using the specified option.
  - defaultQueryBinding
```
public java.lang.String defaultQueryBinding()
```
    Indicates which query binding to use if not specified in the Schema.
    
    Returns:
    
    "xslt" by default, "xslt2" in compatibility mode.
  - isCompact
```
public boolean isCompact()
```
    Indicates whether to only generate the compact SVRL output
    
    Returns:
    
    false by default
  - hasMetadata
```
public boolean hasMetadata()
```
    Indicates whether to include the `` element in the SVRL output
    
    Returns:
    
    false by default
  - isStreamable
```
public boolean isStreamable()
```
    Returns:
    
    false by default
  - toParameters
```
public java.util.Map<java.lang.String,java.lang.Object> toParameters()
```
    Returns:
    
    the parameters sent to the preprocessors which are equivalent to these options.
  - toParameters
```
public java.util.Map<java.lang.String,java.lang.Object> toParameters(java.lang.String phase)
```
    Returns a new mutable parameter map containing the parameters corresponding to these options.
    
    Parameters:
    
    phase - The phase to use for validation
    
    Returns:
    
    the parameters sent to the preprocessors which are equivalent to these options.
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class CompileOptions

Method Summary

Methods inherited from class java.lang.Object

Method Detail

defaults

defaultQueryBinding

metadata

streamable

compact

defaultQueryBinding

isCompact

hasMetadata

isStreamable

toParameters

toParameters

equals

hashCode

toString