com.exalead.indexing.analysis.v10

Class PartMapping

java.lang.Object

com.exalead.indexing.analysis.v10.PartMapping

All Implemented Interfaces:

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

public class PartMapping
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

PartMapping specifies how parts are remapped to index fields.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_PATTERN_MATCH
static boolean	DEFAULT_PREFIX_MATCH
java.lang.String	name
java.util.List<PartTarget>	partTarget
boolean	patternMatch
boolean	prefixMatch

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this PartMapping.
static PartMapping	fromString(java.lang.String s) String representation of this PartMapping.
java.lang.String	getName() Name of the Part to map.
java.util.List<PartTarget>	getPartTarget()
boolean	isPatternMatch() Matches all parts matching this pattern (must be a valid regular expression).
boolean	isPrefixMatch() Matches all parts that starts with this prefix.
PartMapping	makeCopy() Creates and returns a deep copy of this PartMapping.
static PartMapping	readFrom(java.io.InputStream is) Read this PartMapping from an XML fragment.
void	setName(java.lang.String name) Name of the Part to map.
void	setPatternMatch(boolean patternMatch) Matches all parts matching this pattern (must be a valid regular expression).
void	setPrefixMatch(boolean prefixMatch) Matches all parts that starts with this prefix.
java.lang.String	toString() String representation of this PartMapping.
PartMapping	withName(java.lang.String name)
PartMapping	withPartTarget(java.util.Collection<PartTarget> __values)
PartMapping	withPartTarget(PartTarget... __values)
PartMapping	withPatternMatch(boolean patternMatch)
PartMapping	withPatternMatch(java.lang.Boolean patternMatch)
PartMapping	withPrefixMatch(boolean prefixMatch)
PartMapping	withPrefixMatch(java.lang.Boolean prefixMatch)
void	writeTo(java.io.OutputStream os) Write this PartMapping as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

partTarget

public java.util.List<PartTarget> partTarget

name

public java.lang.String name

prefixMatch

public boolean prefixMatch

DEFAULT_PREFIX_MATCH

public static final boolean DEFAULT_PREFIX_MATCH

See Also:

Constant Field Values

patternMatch

public boolean patternMatch

DEFAULT_PATTERN_MATCH

public static final boolean DEFAULT_PATTERN_MATCH

See Also:

Constant Field Values

Constructor Detail

PartMapping

public PartMapping()

PartMapping

public PartMapping(PartMapping o)

Copy constructor

Method Detail

getPartTarget

public java.util.List<PartTarget> getPartTarget()

withPartTarget

public PartMapping withPartTarget(PartTarget... __values)

withPartTarget

public PartMapping withPartTarget(java.util.Collection<PartTarget> __values)

setName

public void setName(java.lang.String name)

Name of the Part to map.

getName

public java.lang.String getName()

Name of the Part to map.

withName

public PartMapping withName(java.lang.String name)

setPrefixMatch

public void setPrefixMatch(boolean prefixMatch)

Matches all parts that starts with this prefix.

isPrefixMatch

public boolean isPrefixMatch()

Matches all parts that starts with this prefix.

withPrefixMatch

public PartMapping withPrefixMatch(boolean prefixMatch)

withPrefixMatch

public PartMapping withPrefixMatch(java.lang.Boolean prefixMatch)

setPatternMatch

public void setPatternMatch(boolean patternMatch)

Matches all parts matching this pattern (must be a valid regular expression).

isPatternMatch

public boolean isPatternMatch()

Matches all parts matching this pattern (must be a valid regular expression).

withPatternMatch

public PartMapping withPatternMatch(boolean patternMatch)

withPatternMatch

public PartMapping withPatternMatch(java.lang.Boolean patternMatch)

makeCopy

public PartMapping makeCopy()

Creates and returns a deep copy of this PartMapping.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this PartMapping.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this PartMapping.

Overrides:

toString in class java.lang.Object

check

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

Checks this PartMapping.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException