com.exalead.indexing.analysis.v10

Class BinaryContentCondition

java.lang.Object

com.exalead.indexing.analysis.v10.AcceptCondition

com.exalead.indexing.analysis.v10.BinaryContentCondition

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class BinaryContentCondition
extends AcceptCondition
implements com.exalead.util.Checkable, java.io.Serializable

A condition that matches if the FIRST document part binary content type matches the binary string.
Note: Conditions work on document but content is set per document part.
BinaryContentCondition only tests the binary content of the first part, if present.

See Also:

Serialized Form

Nested Class Summary

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

AcceptCondition.Transformer<T>

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	match
int	offset

Constructor Summary

Constructors

Constructor and Description
BinaryContentCondition()
BinaryContentCondition(BinaryContentCondition o) Copy constructor

Method Summary

Modifier and Type	Method and Description
<T> T	accept(AcceptCondition.Transformer<T> transformer, T[] t)
void	check(boolean deep, java.lang.String errorContext) Checks this BinaryContentCondition.
static BinaryContentCondition	fromString(java.lang.String s) String representation of this BinaryContentCondition.
java.lang.String	getMatch() Binary string to be compared. The string may contain any ASCII (7-bit) character, or the following '\' escape sequences: \xNN An hexadecimal-encoded character (N part of '0'..'9' or 'A'..'F') \NNN An octal-encoded character (N part of '0'..'9') \n Character 10 \r Character 13 \\ Character '\' \" Character '"' \? Any character
int	getOffset() Offset in bytes for the binary data to be compared, in bytes (0 for the beginning of the file). Negative values are taken as offset from the end of the file (-1 for the last byte).
BinaryContentCondition	makeCopy() Creates and returns a deep copy of this BinaryContentCondition.
static BinaryContentCondition	readFrom(java.io.InputStream is) Read this BinaryContentCondition from an XML fragment.
void	setMatch(java.lang.String match) Binary string to be compared. The string may contain any ASCII (7-bit) character, or the following '\' escape sequences: \xNN An hexadecimal-encoded character (N part of '0'..'9' or 'A'..'F') \NNN An octal-encoded character (N part of '0'..'9') \n Character 10 \r Character 13 \\ Character '\' \" Character '"' \? Any character
void	setOffset(int offset) Offset in bytes for the binary data to be compared, in bytes (0 for the beginning of the file). Negative values are taken as offset from the end of the file (-1 for the last byte).
java.lang.String	toString() String representation of this BinaryContentCondition.
BinaryContentCondition	withMatch(java.lang.String match)
BinaryContentCondition	withOffset(int offset)
BinaryContentCondition	withOffset(java.lang.Integer offset)
void	writeTo(java.io.OutputStream os) Write this BinaryContentCondition as an XML fragment

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

offset

public int offset

match

public java.lang.String match

Constructor Detail

BinaryContentCondition

public BinaryContentCondition()

BinaryContentCondition

public BinaryContentCondition(BinaryContentCondition o)

Copy constructor

Method Detail

setOffset

public void setOffset(int offset)

Offset in bytes for the binary data to be compared, in bytes (0 for the beginning of the file).
Negative values are taken as offset from the end of the file (-1 for the last byte).

getOffset

public int getOffset()

Offset in bytes for the binary data to be compared, in bytes (0 for the beginning of the file).
Negative values are taken as offset from the end of the file (-1 for the last byte).

withOffset

public BinaryContentCondition withOffset(int offset)

withOffset

public BinaryContentCondition withOffset(java.lang.Integer offset)

setMatch

public void setMatch(java.lang.String match)

Binary string to be compared.
The string may contain any ASCII (7-bit) character, or the following '\' escape sequences:

• \xNN An hexadecimal-encoded character (N part of '0'..'9' or 'A'..'F')
• \NNN An octal-encoded character (N part of '0'..'9')
• \n Character 10
• \r Character 13
• \\ Character '\'
• \" Character '"'
• \? Any character

getMatch

public java.lang.String getMatch()

Binary string to be compared.
The string may contain any ASCII (7-bit) character, or the following '\' escape sequences:

• \xNN An hexadecimal-encoded character (N part of '0'..'9' or 'A'..'F')
• \NNN An octal-encoded character (N part of '0'..'9')
• \n Character 10
• \r Character 13
• \\ Character '\'
• \" Character '"'
• \? Any character

withMatch

public BinaryContentCondition withMatch(java.lang.String match)

makeCopy

public BinaryContentCondition makeCopy()

Creates and returns a deep copy of this BinaryContentCondition.

Overrides:

makeCopy in class AcceptCondition

readFrom

public static BinaryContentCondition readFrom(java.io.InputStream is)
                                       throws javax.xml.bind.JAXBException

Read this BinaryContentCondition 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 BinaryContentCondition as an XML fragment

Overrides:

writeTo in class AcceptCondition

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static BinaryContentCondition fromString(java.lang.String s)
                                         throws javax.xml.bind.JAXBException,
                                                java.io.UnsupportedEncodingException

String representation of this BinaryContentCondition.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this BinaryContentCondition.

Overrides:

toString in class AcceptCondition

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this BinaryContentCondition.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class AcceptCondition

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(AcceptCondition.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Specified by:

accept in class AcceptCondition

Throws:

com.exalead.util.TypedException