java.lang.Object
org.apache.lucene.document.Field
org.apache.lucene.document.InetAddressRange
- All Implemented Interfaces:
IndexableField
An indexed InetAddress Range Field
This field indexes an InetAddress
range defined as a min/max pairs. It is single
dimension only (indexed as two 16 byte paired values).
Multiple values are supported.
This field defines the following static factory methods for common search operations over Ip Ranges
newIntersectsQuery()
matches ip ranges that intersect the defined search range.newWithinQuery()
matches ip ranges that are within the defined search range.newContainsQuery()
matches ip ranges that contain the defined search range.newCrossesQuery()
matches ip ranges that cross the defined search range
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.document.Field
Field.Store
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
The number of bytes per dimension : sync w/InetAddressPoint
private static final FieldType
Fields inherited from class org.apache.lucene.document.Field
fieldsData, name, type
-
Constructor Summary
ConstructorsConstructorDescriptionInetAddressRange
(String name, InetAddress min, InetAddress max) Create a new InetAddressRange from min/max value -
Method Summary
Modifier and TypeMethodDescriptionprivate static byte[]
encode
(InetAddress min, InetAddress max) encode the min/max range and return the byte arrayprivate static void
encode
(InetAddress min, InetAddress max, byte[] bytes) encode the min/max range into the provided byte arraystatic Query
newContainsQuery
(String field, InetAddress min, InetAddress max) Create a query for matching indexed ip ranges thatCONTAINS
the defined range.static Query
newCrossesQuery
(String field, InetAddress min, InetAddress max) Create a query for matching indexed ip ranges thatCROSS
the defined range.static Query
newIntersectsQuery
(String field, InetAddress min, InetAddress max) Create a query for matching indexed ip ranges thatINTERSECT
the defined range.private static Query
newRelationQuery
(String field, InetAddress min, InetAddress max, RangeFieldQuery.QueryType relation) helper method for creating the desired relational querystatic Query
newWithinQuery
(String field, InetAddress min, InetAddress max) Create a query for matching indexed ip ranges that areWITHIN
the defined range.void
setRangeValues
(InetAddress min, InetAddress max) Change (or set) the min/max values of the field.private static String
toString
(byte[] ranges, int dimension) Returns the String representation for the range at the given dimensionMethods inherited from class org.apache.lucene.document.Field
binaryValue, fieldType, getCharSequenceValue, invertableType, name, numericValue, readerValue, setBytesValue, setBytesValue, setByteValue, setDoubleValue, setFloatValue, setIntValue, setLongValue, setReaderValue, setShortValue, setStringValue, setTokenStream, storedValue, stringValue, tokenStream, tokenStreamValue, toString
-
Field Details
-
BYTES
public static final int BYTESThe number of bytes per dimension : sync w/InetAddressPoint
- See Also:
-
TYPE
-
-
Constructor Details
-
InetAddressRange
Create a new InetAddressRange from min/max value- Parameters:
name
- field name. must not be null.min
- range min value; defined as anInetAddress
max
- range max value; defined as anInetAddress
-
-
Method Details
-
setRangeValues
Change (or set) the min/max values of the field.- Parameters:
min
- range min value; defined as anInetAddress
max
- range max value; defined as anInetAddress
-
encode
encode the min/max range into the provided byte array -
encode
encode the min/max range and return the byte array -
newIntersectsQuery
Create a query for matching indexed ip ranges thatINTERSECT
the defined range.- Parameters:
field
- field name. must not be null.min
- range min value; provided as anInetAddress
max
- range max value; provided as anInetAddress
- Returns:
- query for matching intersecting ranges (overlap, within, crosses, or contains)
- Throws:
IllegalArgumentException
- iffield
is null,min
ormax
is invalid
-
newContainsQuery
Create a query for matching indexed ip ranges thatCONTAINS
the defined range.- Parameters:
field
- field name. must not be null.min
- range min value; provided as anInetAddress
max
- range max value; provided as anInetAddress
- Returns:
- query for matching intersecting ranges (overlap, within, crosses, or contains)
- Throws:
IllegalArgumentException
- iffield
is null,min
ormax
is invalid
-
newWithinQuery
Create a query for matching indexed ip ranges that areWITHIN
the defined range.- Parameters:
field
- field name. must not be null.min
- range min value; provided as anInetAddress
max
- range max value; provided as anInetAddress
- Returns:
- query for matching intersecting ranges (overlap, within, crosses, or contains)
- Throws:
IllegalArgumentException
- iffield
is null,min
ormax
is invalid
-
newCrossesQuery
Create a query for matching indexed ip ranges thatCROSS
the defined range.- Parameters:
field
- field name. must not be null.min
- range min value; provided as anInetAddress
max
- range max value; provided as anInetAddress
- Returns:
- query for matching intersecting ranges (overlap, within, crosses, or contains)
- Throws:
IllegalArgumentException
- iffield
is null,min
ormax
is invalid
-
newRelationQuery
private static Query newRelationQuery(String field, InetAddress min, InetAddress max, RangeFieldQuery.QueryType relation) helper method for creating the desired relational query -
toString
Returns the String representation for the range at the given dimension- Parameters:
ranges
- the encoded ranges, never nulldimension
- the dimension of interest (not used for this field)- Returns:
- The string representation for the range at the provided dimension
-