@groovy.transform.CompileStatic @groovy.transform.builder.Builder(builderStrategy: SimpleStrategy, prefix: ) class MongoAttribute extends org.grails.datastore.mapping.document.config.Attribute
Extends org.grails.datastore.mapping.document.config.Attribute class with additional Mongo specific configuration
Modifiers | Name | Description |
---|---|---|
static java.lang.String |
INDEX_TYPE |
|
static java.lang.String |
INDEX_TYPE_2D |
|
static java.lang.String |
INDEX_TYPE_2DSPHERE |
Fields inherited from class | Fields |
---|---|
class org.grails.datastore.mapping.document.config.Attribute |
__$stMC, __$stMC |
Type | Name and description |
---|---|
java.lang.String |
field |
java.util.Map |
indexAttributes |
boolean |
reference Whether this attribute is a database reference |
Constructor and description |
---|
MongoAttribute() |
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()
|
|
java.util.Map |
getIndexAttributes()
|
|
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 |
Methods inherited from class | Name |
---|---|
class org.grails.datastore.mapping.document.config.Attribute |
org.grails.datastore.mapping.document.config.Attribute#setAttr(java.lang.String), org.grails.datastore.mapping.document.config.Attribute#$getLookup(), org.grails.datastore.mapping.document.config.Attribute#attr(java.lang.String), org.grails.datastore.mapping.document.config.Attribute#attribute(java.lang.String), org.grails.datastore.mapping.document.config.Attribute#setAttribute(java.lang.String), org.grails.datastore.mapping.document.config.Attribute#isReference(), org.grails.datastore.mapping.document.config.Attribute#getAccessType(), org.grails.datastore.mapping.document.config.Attribute#isIndex(), org.grails.datastore.mapping.document.config.Attribute#setRange(groovy.lang.ObjectRange), org.grails.datastore.mapping.document.config.Attribute#unique(java.lang.String), org.grails.datastore.mapping.document.config.Attribute#unique(java.util.List), org.grails.datastore.mapping.document.config.Attribute#unique(boolean), org.grails.datastore.mapping.document.config.Attribute#isNullable(), org.grails.datastore.mapping.document.config.Attribute#getScale(), org.grails.datastore.mapping.document.config.Attribute#getNullable(), org.grails.datastore.mapping.document.config.Attribute#fetch(jakarta.persistence.FetchType), org.grails.datastore.mapping.document.config.Attribute#fetch(java.lang.String), org.grails.datastore.mapping.document.config.Attribute#nullable(boolean), org.grails.datastore.mapping.document.config.Attribute#isUnique(), org.grails.datastore.mapping.document.config.Attribute#getTargetName(), org.grails.datastore.mapping.document.config.Attribute#setDerived(boolean), org.grails.datastore.mapping.document.config.Attribute#configureExisting(org.grails.datastore.mapping.config.Property, java.util.Map), org.grails.datastore.mapping.document.config.Attribute#configureExisting(org.grails.datastore.mapping.config.Property, groovy.lang.Closure), org.grails.datastore.mapping.document.config.Attribute#setFetch(java.lang.String), org.grails.datastore.mapping.document.config.Attribute#setFetchStrategy(jakarta.persistence.FetchType), org.grails.datastore.mapping.document.config.Attribute#isUniqueWithinGroup(), org.grails.datastore.mapping.document.config.Attribute#setUnique(boolean), org.grails.datastore.mapping.document.config.Attribute#setUnique(java.lang.String), org.grails.datastore.mapping.document.config.Attribute#setUnique(java.util.List), org.grails.datastore.mapping.document.config.Attribute#getUniquenessGroup(), org.grails.datastore.mapping.document.config.Attribute#getEnumType(), org.grails.datastore.mapping.document.config.Attribute#getEnumTypeObject(), org.grails.datastore.mapping.document.config.Attribute#setEnumType(java.lang.String), org.grails.datastore.mapping.document.config.Attribute#setEnumType(jakarta.persistence.EnumType), org.grails.datastore.mapping.document.config.Attribute#setTargetName(java.lang.String), org.grails.datastore.mapping.document.config.Attribute#cascadeValidate(java.lang.String), org.grails.datastore.mapping.document.config.Attribute#formula(java.lang.String), org.grails.datastore.mapping.document.config.Attribute#setInList(java.util.List), org.grails.datastore.mapping.document.config.Attribute#setNullable(boolean), org.grails.datastore.mapping.document.config.Attribute#setReference(boolean), org.grails.datastore.mapping.document.config.Attribute#setGenerator(java.lang.String), org.grails.datastore.mapping.document.config.Attribute#setMaxSize(java.lang.Number), org.grails.datastore.mapping.document.config.Attribute#setMinSize(java.lang.Number), org.grails.datastore.mapping.document.config.Attribute#setMax(java.lang.Comparable), org.grails.datastore.mapping.document.config.Attribute#setMin(java.lang.Comparable), org.grails.datastore.mapping.document.config.Attribute#getDerived(), org.grails.datastore.mapping.document.config.Attribute#getOrphanRemoval(), org.grails.datastore.mapping.document.config.Attribute#setOrphanRemoval(boolean), org.grails.datastore.mapping.document.config.Attribute#setCascade(java.lang.String), org.grails.datastore.mapping.document.config.Attribute#setCascadeValidate(java.lang.String), org.grails.datastore.mapping.document.config.Attribute#setCascades(java.util.List), org.grails.datastore.mapping.document.config.Attribute#getFormula(), org.grails.datastore.mapping.document.config.Attribute#setFormula(java.lang.String), org.grails.datastore.mapping.document.config.Attribute#setAccessType(jakarta.persistence.AccessType), org.grails.datastore.mapping.document.config.Attribute#inList(java.util.List), org.grails.datastore.mapping.document.config.Attribute#super$1$clone(), org.grails.datastore.mapping.document.config.Attribute#isLazy(), org.grails.datastore.mapping.document.config.Attribute#cascades(java.util.List), org.grails.datastore.mapping.document.config.Attribute#cascade(java.lang.String), org.grails.datastore.mapping.document.config.Attribute#getInList(), org.grails.datastore.mapping.document.config.Attribute#isDerived(), org.grails.datastore.mapping.document.config.Attribute#fetchStrategy(jakarta.persistence.FetchType), org.grails.datastore.mapping.document.config.Attribute#getFetchStrategy(), org.grails.datastore.mapping.document.config.Attribute#getLazy(), org.grails.datastore.mapping.document.config.Attribute#setLazy(java.lang.Boolean), org.grails.datastore.mapping.document.config.Attribute#orphanRemoval(boolean), org.grails.datastore.mapping.document.config.Attribute#isOrphanRemoval(), org.grails.datastore.mapping.document.config.Attribute#getCascade(), org.grails.datastore.mapping.document.config.Attribute#getCascades(), org.grails.datastore.mapping.document.config.Attribute#getCascadeValidate(), org.grails.datastore.mapping.document.config.Attribute#derived(boolean), org.grails.datastore.mapping.document.config.Attribute#getGenerator(), org.grails.datastore.mapping.document.config.Attribute#getMinSize(), org.grails.datastore.mapping.document.config.Attribute#getMaxSize(), org.grails.datastore.mapping.document.config.Attribute#index(boolean), org.grails.datastore.mapping.document.config.Attribute#getName(), org.grails.datastore.mapping.document.config.Attribute#name(java.lang.String), org.grails.datastore.mapping.document.config.Attribute#clone(), org.grails.datastore.mapping.document.config.Attribute#clone(), org.grails.datastore.mapping.document.config.Attribute#min(java.lang.Comparable), org.grails.datastore.mapping.document.config.Attribute#max(java.lang.Comparable), org.grails.datastore.mapping.document.config.Attribute#getReference(), org.grails.datastore.mapping.document.config.Attribute#scale(int), org.grails.datastore.mapping.document.config.Attribute#setName(java.lang.String), org.grails.datastore.mapping.document.config.Attribute#reference(boolean), org.grails.datastore.mapping.document.config.Attribute#generator(java.lang.String), org.grails.datastore.mapping.document.config.Attribute#getIndex(), org.grails.datastore.mapping.document.config.Attribute#targetName(java.lang.String), org.grails.datastore.mapping.document.config.Attribute#setScale(int), org.grails.datastore.mapping.document.config.Attribute#maxSize(java.lang.Number), org.grails.datastore.mapping.document.config.Attribute#setIndex(boolean), org.grails.datastore.mapping.document.config.Attribute#setSize(groovy.lang.IntRange), org.grails.datastore.mapping.document.config.Attribute#lazy(java.lang.Boolean), org.grails.datastore.mapping.document.config.Attribute#getMin(), org.grails.datastore.mapping.document.config.Attribute#getMax(), org.grails.datastore.mapping.document.config.Attribute#getMetaClass(), org.grails.datastore.mapping.document.config.Attribute#setMetaClass(groovy.lang.MetaClass), org.grails.datastore.mapping.document.config.Attribute#accessType(jakarta.persistence.AccessType), org.grails.datastore.mapping.document.config.Attribute#minSize(java.lang.Number), org.grails.datastore.mapping.document.config.Attribute#wait(long, int), org.grails.datastore.mapping.document.config.Attribute#wait(), org.grails.datastore.mapping.document.config.Attribute#wait(long), org.grails.datastore.mapping.document.config.Attribute#equals(java.lang.Object), org.grails.datastore.mapping.document.config.Attribute#toString(), org.grails.datastore.mapping.document.config.Attribute#hashCode(), org.grails.datastore.mapping.document.config.Attribute#getClass(), org.grails.datastore.mapping.document.config.Attribute#notify(), org.grails.datastore.mapping.document.config.Attribute#notifyAll(), org.grails.datastore.mapping.document.config.Attribute#getProperty(java.lang.String), org.grails.datastore.mapping.document.config.Attribute#setProperty(java.lang.String, java.lang.Object), org.grails.datastore.mapping.document.config.Attribute#invokeMethod(java.lang.String, java.lang.Object) |
Whether this attribute is a database reference
Configures the field name to map to
name
- The name of the fieldSets the geo index type
indexType
- The geo index type
Configures the index type
type
- The index typeConfigures the index attributes
indexAttributes
- The index attributesSets the field name to map to
name
- The field nameSets the geo index type
indexType
- The geo index typeSets the index type
type
- The index typeSets index attributes
indexAttributes
- The index attributesGroovy Documentation