MongoProperty (Axon Framework 2.3.2 API)

java.lang.Object
- org.axonframework.eventstore.mongo.criteria.MongoProperty

All Implemented Interfaces:

Property
```
public class MongoProperty
extends Object
implements Property
```
Property implementation for use by the Mongo Event Store.

Since:

2.0

Author:

Allard Buijze

Constructor Summary

Constructors
Constructor and Description

MongoProperty(String propertyName)
Initialize a property for the given propertyName.

Constructors
Constructor and Description
`MongoProperty(String propertyName)` Initialize a property for the given `propertyName`.

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getName()` Returns the name of the property.
`MongoCriteria`	`greaterThan(Object expression)` Returns a criteria instance where the property must be "greater than" the given `expression`.
`MongoCriteria`	`greaterThanEquals(Object expression)` Returns a criteria instance where the property must be "greater than" or "equal to" the given `expression`.
`MongoCriteria`	`in(Object expression)` Returns a criteria instance where the property must be "in" the given `expression`.
`MongoCriteria`	`is(Object expression)` Returns a criteria instance where the property must "equal" the given `expression`.
`MongoCriteria`	`isNot(Object expression)` Returns a criteria instance where the property must be "not equal to" the given `expression`.
`MongoCriteria`	`lessThan(Object expression)` Returns a criteria instance where the property must be "less than" the given `expression`.
`MongoCriteria`	`lessThanEquals(Object expression)` Returns a criteria instance where the property must be "less than" or "equal to" the given `expression`.
`MongoCriteria`	`notIn(Object expression)` Returns a criteria instance where the property must be "not in" the given `expression`.

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

- Constructor Detail
  - MongoProperty
```
public MongoProperty(String propertyName)
```
    Initialize a property for the given propertyName.
    
    Parameters:
    propertyName - The name of the property of the Mongo document.
- Method Detail
  - lessThan
```
public MongoCriteria lessThan(Object expression)
```
    Description copied from interface: Property
    
    Returns a criteria instance where the property must be "less than" the given expression. Some event stores also allow the given expression to be a property.
    
    Specified by:
    
    lessThan in interface Property
    
    Parameters:
    expression - The expression to match against the property
    
    Returns:
    a criteria instance describing a "less than" requirement.
  - lessThanEquals
```
public MongoCriteria lessThanEquals(Object expression)
```
    Description copied from interface: Property
    
    Returns a criteria instance where the property must be "less than" or "equal to" the given expression. Some event stores also allow the given expression to be a property.
    
    Specified by:
    
    lessThanEquals in interface Property
    
    Parameters:
    expression - The expression to match against the property
    
    Returns:
    a criteria instance describing a "less than or equals" requirement.
  - greaterThan
```
public MongoCriteria greaterThan(Object expression)
```
    Description copied from interface: Property
    
    Returns a criteria instance where the property must be "greater than" the given expression. Some event stores also allow the given expression to be a property.
    
    Specified by:
    
    greaterThan in interface Property
    
    Parameters:
    expression - The expression to match against the property
    
    Returns:
    a criteria instance describing a "greater than" requirement.
  - greaterThanEquals
```
public MongoCriteria greaterThanEquals(Object expression)
```
    Description copied from interface: Property
    
    Returns a criteria instance where the property must be "greater than" or "equal to" the given expression. Some event stores also allow the given expression to be a property.
    
    Specified by:
    
    greaterThanEquals in interface Property
    
    Parameters:
    expression - The expression to match against the property
    
    Returns:
    a criteria instance describing a "greater than or equals" requirement.
  - is
```
public MongoCriteria is(Object expression)
```
    Description copied from interface: Property
    
    Returns a criteria instance where the property must "equal" the given expression. Some event stores also allow the given expression to be a property.
    
    Specified by:
    
    is in interface Property
    
    Parameters:
    expression - The expression to match against the property
    
    Returns:
    a criteria instance describing an "equals" requirement.
  - isNot
```
public MongoCriteria isNot(Object expression)
```
    Description copied from interface: Property
    
    Returns a criteria instance where the property must be "not equal to" the given expression. Some event stores also allow the given expression to be a property.
    
    Specified by:
    
    isNot in interface Property
    
    Parameters:
    expression - The expression to match against the property
    
    Returns:
    a criteria instance describing a "not equals" requirement.
  - in
```
public MongoCriteria in(Object expression)
```
    Description copied from interface: Property
    
    Returns a criteria instance where the property must be "in" the given expression. Some event stores also allow the given expression to be a property.
    Note that the given expression must describe a collection of some sort.
    
    Specified by:
    
    in in interface Property
    
    Parameters:
    expression - The expression to match against the property
    
    Returns:
    a criteria instance describing a "is in" requirement.
  - notIn
```
public MongoCriteria notIn(Object expression)
```
    Description copied from interface: Property
    
    Returns a criteria instance where the property must be "not in" the given expression. Some event stores also allow the given expression to be a property.
    
    Specified by:
    
    notIn in interface Property
    
    Parameters:
    expression - The expression to match against the property
    
    Returns:
    a criteria instance describing a "is not in" requirement.
  - getName
```
public String getName()
```
    Returns the name of the property.
    
    Returns:
    the name of the property

Class MongoProperty

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MongoProperty

Method Detail

lessThan

lessThanEquals

greaterThan

greaterThanEquals

is

isNot

in

notIn

getName