PrintfValues (NETVIBES Exalead CloudView Clients SDK)

java.lang.Object
- com.exalead.indexing.analysis.v10.DocumentProcessor
- - com.exalead.indexing.analysis.v10.PrintfValues

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable
```
public class PrintfValues
extends DocumentProcessor
implements com.exalead.util.Checkable, java.io.Serializable
```
Prints textual content of DocumentChunks according to a formatting string.
This string contains variables in one of the 3 following formats:
1. $(name), the name of a context: output is the textual content of this context.
2. $/name:regexp/, the name of a context whose chunks must match the regexp: output is the piece of text that has matched.
3. $/name:regexp:format/, the name of a context whose chunks must match the regexp: output is defined by a sed-like format referencing the regexp subexpressions.
Warning: In the regexp and format parts, colons and slashes must be escaped with a backslash.
For example : "$(firstname) $(lastname) : $/age:[0-9]+/ $/date:([0-9]{2})([0-9]{2})([0-9]{4}):day=\\1 month=\\2 year=\\3"
Warning: The context used in this method cannot be produced by another processor. It should come from the connector.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class com.exalead.indexing.analysis.v10.DocumentProcessor
  DocumentProcessor.FromDataModel, DocumentProcessor.Transformer<T>

Field Summary

Fields
Modifier and Type Field and Description

static boolean DEFAULT_STRICT

java.lang.String formattingString

java.lang.String outputContext

boolean strict
- Fields inherited from class com.exalead.indexing.analysis.v10.DocumentProcessor
  acceptCondition, dataModelClass, dataModelProperty, dataModelState, DEFAULT_DISABLED, disabled, fromDataModel, name

Fields
Modifier and Type	Field and Description
`static boolean`	`DEFAULT_STRICT`
`java.lang.String`	`formattingString`
`java.lang.String`	`outputContext`
`boolean`	`strict`

Constructor Summary

Constructors
Constructor and Description

PrintfValues()

PrintfValues(PrintfValues o)
Copy constructor

Constructors
Constructor and Description
`PrintfValues()`
`PrintfValues(PrintfValues o)` Copy constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T> T`	`accept(DocumentProcessor.Transformer<T> transformer, T[] t)`
`void`	`check(boolean deep, java.lang.String errorContext)` Checks this PrintfValues.
`static PrintfValues`	`fromString(java.lang.String s)` String representation of this PrintfValues.
`java.lang.String`	`getFormattingString()` This string contains variables in one of the 3 following formats: 1.
`java.lang.String`	`getOutputContext()` ContextName to be associated with the DocumentChunk created for each generated value.
`boolean`	`isStrict()` Forces all the manipulated contexts found to process.
`PrintfValues`	`makeCopy()` Creates and returns a deep copy of this PrintfValues.
`static PrintfValues`	`readFrom(java.io.InputStream is)` Read this PrintfValues from an XML fragment.
`void`	`setFormattingString(java.lang.String formattingString)` This string contains variables in one of the 3 following formats: 1.
`void`	`setOutputContext(java.lang.String outputContext)` ContextName to be associated with the DocumentChunk created for each generated value.
`void`	`setStrict(boolean strict)` Forces all the manipulated contexts found to process.
`java.lang.String`	`toString()` String representation of this PrintfValues.
`PrintfValues`	`withAcceptCondition(AcceptCondition acceptCondition)`
`PrintfValues`	`withDataModelClass(java.lang.String dataModelClass)`
`PrintfValues`	`withDataModelProperty(java.lang.String dataModelProperty)`
`PrintfValues`	`withDataModelState(java.lang.String dataModelState)`
`PrintfValues`	`withDisabled(boolean disabled)`
`PrintfValues`	`withDisabled(java.lang.Boolean disabled)`
`PrintfValues`	`withFormattingString(java.lang.String formattingString)`
`PrintfValues`	`withFromDataModel(DocumentProcessor fromDataModel)`
`PrintfValues`	`withName(java.lang.String name)`
`PrintfValues`	`withOutputContext(java.lang.String outputContext)`
`PrintfValues`	`withStrict(boolean strict)`
`PrintfValues`	`withStrict(java.lang.Boolean strict)`
`void`	`writeTo(java.io.OutputStream os)` Write this PrintfValues as an XML fragment

Methods inherited from class com.exalead.indexing.analysis.v10.DocumentProcessor
getAcceptCondition, getDataModelClass, getDataModelProperty, getDataModelState, getFromDataModel, getName, isDisabled, setAcceptCondition, setDataModelClass, setDataModelProperty, setDataModelState, setDisabled, setFromDataModel, setName

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

- Field Detail
  - formattingString
```
public java.lang.String formattingString
```
  - outputContext
```
public java.lang.String outputContext
```
  - strict
```
public boolean strict
```
  - DEFAULT_STRICT
```
public static final boolean DEFAULT_STRICT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PrintfValues
```
public PrintfValues()
```
  - PrintfValues
```
public PrintfValues(PrintfValues o)
```
    Copy constructor
- Method Detail
  - withAcceptCondition
```
public PrintfValues withAcceptCondition(AcceptCondition acceptCondition)
```
    Overrides:
    
    withAcceptCondition in class DocumentProcessor
  - withName
```
public PrintfValues withName(java.lang.String name)
```
    Overrides:
    
    withName in class DocumentProcessor
  - withDataModelState
```
public PrintfValues withDataModelState(java.lang.String dataModelState)
```
    Overrides:
    
    withDataModelState in class DocumentProcessor
  - withFromDataModel
```
public PrintfValues withFromDataModel(DocumentProcessor fromDataModel)
```
  - withDataModelClass
```
public PrintfValues withDataModelClass(java.lang.String dataModelClass)
```
    Overrides:
    
    withDataModelClass in class DocumentProcessor
  - withDataModelProperty
```
public PrintfValues withDataModelProperty(java.lang.String dataModelProperty)
```
    Overrides:
    
    withDataModelProperty in class DocumentProcessor
  - withDisabled
```
public PrintfValues withDisabled(boolean disabled)
```
    Overrides:
    
    withDisabled in class DocumentProcessor
  - withDisabled
```
public PrintfValues withDisabled(java.lang.Boolean disabled)
```
    Overrides:
    
    withDisabled in class DocumentProcessor
  - setFormattingString
```
public void setFormattingString(java.lang.String formattingString)
```
    This string contains variables in one of the 3 following formats:
    1. $(name), the name of a context: output is the textual content of this context.
    2. $/name:regexp/, the name of a context whose chunks must match the regexp: output is the piece of text that has matched.
    3. $/name:regexp:format/, the name of a context whose chunks must match the regexp: output is defined by a sed-like format referencing the regexp subexpressions.
    Warning: Colons and slashes must be escaped with a backslash.
    For example : "$(firstname) $(lastname) : $/age:[0-9]+/ $/date:([0-9]{2})([0-9]{2})([0-9]{4}):day=\\1 month=\\2 year=\\3"
  - getFormattingString
```
public java.lang.String getFormattingString()
```
    This string contains variables in one of the 3 following formats:
    1. $(name), the name of a context: output is the textual content of this context.
    2. $/name:regexp/, the name of a context whose chunks must match the regexp: output is the piece of text that has matched.
    3. $/name:regexp:format/, the name of a context whose chunks must match the regexp: output is defined by a sed-like format referencing the regexp subexpressions.
    Warning: Colons and slashes must be escaped with a backslash.
    For example : "$(firstname) $(lastname) : $/age:[0-9]+/ $/date:([0-9]{2})([0-9]{2})([0-9]{4}):day=\\1 month=\\2 year=\\3"
  - withFormattingString
```
public PrintfValues withFormattingString(java.lang.String formattingString)
```
  - setOutputContext
```
public void setOutputContext(java.lang.String outputContext)
```
    ContextName to be associated with the DocumentChunk created for each generated value.
  - getOutputContext
```
public java.lang.String getOutputContext()
```
    ContextName to be associated with the DocumentChunk created for each generated value.
  - withOutputContext
```
public PrintfValues withOutputContext(java.lang.String outputContext)
```
  - setStrict
```
public void setStrict(boolean strict)
```
    Forces all the manipulated contexts found to process.
  - isStrict
```
public boolean isStrict()
```
    Forces all the manipulated contexts found to process.
  - withStrict
```
public PrintfValues withStrict(boolean strict)
```
  - withStrict
```
public PrintfValues withStrict(java.lang.Boolean strict)
```
  - makeCopy
```
public PrintfValues makeCopy()
```
    Creates and returns a deep copy of this PrintfValues.
    
    Overrides:
    
    makeCopy in class DocumentProcessor
  - readFrom
```
public static PrintfValues readFrom(java.io.InputStream is)
                             throws javax.xml.bind.JAXBException
```
    Read this PrintfValues from an XML fragment.
    
    Throws:
    
    javax.xml.bind.JAXBException
  - writeTo
```
public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException
```
    Write this PrintfValues as an XML fragment
    
    Overrides:
    
    writeTo in class DocumentProcessor
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.IOException
  - fromString
```
public static PrintfValues fromString(java.lang.String s)
                               throws javax.xml.bind.JAXBException,
                                      java.io.UnsupportedEncodingException
```
    String representation of this PrintfValues.
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.UnsupportedEncodingException
  - toString
```
public java.lang.String toString()
```
    String representation of this PrintfValues.
    
    Overrides:
    
    toString in class DocumentProcessor
  - check
```
public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException
```
    Checks this PrintfValues.
    
    Specified by:
    
    check in interface com.exalead.util.Checkable
    
    Overrides:
    
    check in class DocumentProcessor
    
    Throws:
    
    com.exalead.util.TypedException
  - accept
```
public <T> T accept(DocumentProcessor.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException
```
    Specified by:
    
    accept in class DocumentProcessor
    
    Throws:
    
    com.exalead.util.TypedException

Class PrintfValues

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.indexing.analysis.v10.DocumentProcessor

Field Summary

Fields inherited from class com.exalead.indexing.analysis.v10.DocumentProcessor

Constructor Summary

Method Summary

Methods inherited from class com.exalead.indexing.analysis.v10.DocumentProcessor

Methods inherited from class java.lang.Object

Field Detail

formattingString

outputContext

strict

DEFAULT_STRICT

Constructor Detail

PrintfValues

PrintfValues

Method Detail

withAcceptCondition

withName

withDataModelState

withFromDataModel

withDataModelClass

withDataModelProperty

withDisabled

withDisabled

setFormattingString

getFormattingString

withFormattingString

setOutputContext

getOutputContext

withOutputContext

setStrict

isStrict

withStrict

withStrict

makeCopy

readFrom

writeTo

fromString

toString

check

accept