MongoAttribute (GORM for Hibernate 5

org.grails.datastore.mapping.mongo.config.MongoAttribute

@groovy.transform.CompileStatic
@groovy.transform.builder.Builder(builderStrategy: SimpleStrategy, prefix: )
class MongoAttribute
extends Attribute

Extends Attribute class with additional Mongo specific configuration

Authors:: Graeme Rocher

Since:: 1.0

Field Summary

Fields
Modifiers	Name	Description
`static java.lang.String`	`INDEX_TYPE`
`static java.lang.String`	`INDEX_TYPE_2D`
`static java.lang.String`	`INDEX_TYPE_2DSPHERE`

Properties Summary

Properties
Type	Name and description
`java.lang.String`	`field`
`java.util.Map`	`indexAttributes`
`boolean`	`reference` Whether this attribute is a database reference

Inherited properties
Properties inherited from class	Properties
`class Property`	`accessType, cascade, cascadeValidate, cascades, derived, enumType, enumType, fetchStrategy, formula, generator, inList, index, lazy, lazy, max, maxSize, min, minSize, name, nullable, orphanRemoval, reference, scale, targetName, unique`

Constructor Summary

Constructors
Constructor and description
`MongoAttribute()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`MongoAttribute`	`field(java.lang.String name)` Configures the field name to map to
	`MongoAttribute`	`geoIndex(java.lang.String indexType)` Sets the geo index type
	`java.lang.String`	`getField()` Returns: The field name to map to
	`java.util.Map`	`getIndexAttributes()` Returns: The attributes for the index
	`MongoAttribute`	`index(java.lang.String type)` Configures the index type
	`MongoAttribute`	`indexAttributes(java.util.Map indexAttributes)` Configures the index attributes
	`void`	`initIndexAttributes()`
	`void`	`setField(java.lang.String name)` Sets the field name to map to
	`void`	`setGeoIndex(java.lang.String indexType)` Sets the geo index type
	`void`	`setIndex(java.lang.String type)` Sets the index type
	`void`	`setIndexAttributes(java.util.Map indexAttributes)` Sets index attributes

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Attribute`	`attr, attribute, setAttr, setAttribute`
`class Property`	`clone, configureExisting, configureExisting, fetch, fetch, getEnumType, getEnumTypeObject, getLazy, getName, getUniquenessGroup, isLazy, isUnique, isUniqueWithinGroup, name, setEnumType, setEnumType, setFetch, setLazy, setName, setRange, setSize, setUnique, setUnique, setUnique, setUniquenessGroup, unique, unique, unique`

- Field Detail
  - public static final java.lang.String INDEX_TYPE
  - public static final java.lang.String INDEX_TYPE_2D
  - public static final java.lang.String INDEX_TYPE_2DSPHERE
- Property Detail
  - java.lang.String field
  - java.util.Map indexAttributes
  - boolean reference
    
    Whether this attribute is a database reference
- Constructor Detail
  - MongoAttribute()
- Method Detail
  - MongoAttribute field(java.lang.String name)
    
    Configures the field name to map to
    Parameters:
    name - The name of the field
    Returns:
    This attribute
  - MongoAttribute geoIndex(java.lang.String indexType)
    
    Sets the geo index type
    Parameters:
    indexType - The geo index type
  - java.lang.String getField()
    
    Returns:
    The field name to map to
  - java.util.Map getIndexAttributes()
    
    Returns:
    The attributes for the index
  - MongoAttribute index(java.lang.String type)
    
    Configures the index type
    Parameters:
    type - The index type
    Returns:
    This attribute
  - MongoAttribute indexAttributes(java.util.Map indexAttributes)
    
    Configures the index attributes
    Parameters:
    indexAttributes - The index attributes
    Returns:
    This attribute
  - @java.lang.SuppressWarnings(value: rawtypes)
    void initIndexAttributes()
  - void setField(java.lang.String name)
    
    Sets the field name to map to
    Parameters:
    name - The field name
  - void setGeoIndex(java.lang.String indexType)
    
    Sets the geo index type
    Parameters:
    indexType - The geo index type
  - void setIndex(java.lang.String type)
    
    Sets the index type
    Parameters:
    type - The index type
  - void setIndexAttributes(java.util.Map indexAttributes)
    
    Sets index attributes
    Parameters:
    indexAttributes - The index attributes

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class MongoAttribute

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final java.lang.String INDEX_TYPE

public static final java.lang.String INDEX_TYPE_2D

public static final java.lang.String INDEX_TYPE_2DSPHERE

Property Detail

java.lang.String field

java.util.Map indexAttributes

boolean reference

Constructor Detail

MongoAttribute()

Method Detail

MongoAttribute field(java.lang.String name)

MongoAttribute geoIndex(java.lang.String indexType)

java.lang.String getField()

java.util.Map getIndexAttributes()

MongoAttribute index(java.lang.String type)

MongoAttribute indexAttributes(java.util.Map indexAttributes)

@java.lang.SuppressWarnings(value: rawtypes)
void initIndexAttributes()

void setField(java.lang.String name)

void setGeoIndex(java.lang.String indexType)

void setIndex(java.lang.String type)

void setIndexAttributes(java.util.Map indexAttributes)

[Groovy] Class MongoAttribute

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final java.lang.String INDEX_TYPE

public static final java.lang.String INDEX_TYPE_2D

public static final java.lang.String INDEX_TYPE_2DSPHERE

Property Detail

java.lang.String field

java.util.Map indexAttributes

boolean reference

Constructor Detail

MongoAttribute()

Method Detail

MongoAttribute field(java.lang.String name)

MongoAttribute geoIndex(java.lang.String indexType)

java.lang.String getField()

java.util.Map getIndexAttributes()

MongoAttribute index(java.lang.String type)

MongoAttribute indexAttributes(java.util.Map indexAttributes)

@java.lang.SuppressWarnings(value: rawtypes)void initIndexAttributes()

void setField(java.lang.String name)

void setGeoIndex(java.lang.String indexType)

void setIndex(java.lang.String type)

void setIndexAttributes(java.util.Map indexAttributes)

@java.lang.SuppressWarnings(value: rawtypes)
void initIndexAttributes()