Feature (Groovy Documentation)

geoscript.feature.Feature

class Feature
extends java.lang.Object

A Feature contains a set of named attributes with values.

A Feature is created from a Map of name value pairs and an identifier.

Without a Schema (see below) the data types are inferred).

 Feature f = new Feature(['name': 'anvil', 'price': 100.0], 'widgets.1')

A Feature can also be created from a list of values, an identifier, and a Schema

 Schema s = new Schema('widgets', [['name','string'],['price','float']])
 Feature f = new Feature(['anvil', 100.0], '1', s)

A Feature can also be created from a Map of name value pairs, an identifier, and a Schema

 Schema s = new Schema('widgets', [['name','string'],['price','float']])
 Feature f = new Feature(['name': 'anvil', 'price': 100.0], '1', s)

Authors:: Jared Erickson

Properties Summary

Properties
Type	Name and description
`SimpleFeature`	`f` The wrapped GeoTools SimpleFeature
`Geometry`	`geom`
`Layer`	`layer` The Layer the Feature was read from
`Schema`	`schema` The Schema

Constructor Summary

Constructors
Constructor and description
`Feature(SimpleFeature f)` Create a new Feature by wrapping a GeoTools SimpleFeature
`Feature(Map attributes, java.lang.String id, Schema schema)` Create a new Feature with a Map of attributes, an id, and a Schema.
`Feature(java.util.List attributes, java.lang.String id, Schema schema)` Create a new Feature with a List of values, an id, and a Schema.
`Feature(Map attributes, java.lang.String id)` Create a new Feature with a Map of Attributes and an Id.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.lang.Object`	`get(java.lang.String name)` Get a value by Field name.
	`java.lang.Object`	`get(Field field)` Get a value by a Field.
	`java.lang.Object`	`getAt(java.lang.String name)` Get a value by Field name.
	`java.lang.Object`	`getAt(Field field)` Get a value by Field.
	`Map`	`getAttributes()` Get a Map of all attributes
	`Bounds`	`getBounds()` The Bounds of the Feature's Geometry.
	`Geometry`	`getGeom()` Get the Feature's Geometry
	`java.lang.String`	`getId()` Get the Feature's ID
	`void`	`putAt(java.lang.String name, java.lang.Object value)` Another way of setting a value.
	`void`	`putAt(Field field, java.lang.Object value)` Set a value
	`void`	`set(java.lang.String name, java.lang.Object value)` Set a value.
	`void`	`set(Field field, java.lang.Object value)` Set a value.
	`void`	`set(Feature f)` Set the values of this Feature based on values from another Feature
	`void`	`set(Map attributes)` Set the values of this Feature based on values from a Map
	`void`	`setGeom(Geometry geom)` Set the Feature's Geometry
	`java.lang.String`	`toString()` The string representation

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - SimpleFeature f
    
    The wrapped GeoTools SimpleFeature
  - Geometry geom
  - Layer layer
    
    The Layer the Feature was read from
  - Schema schema
    
    The Schema
- Constructor Detail
  - Feature(SimpleFeature f)
    
    Create a new Feature by wrapping a GeoTools SimpleFeature
    Parameters:
    f - The GeoTools SimpleFeature
  - Feature(Map attributes, java.lang.String id, Schema schema)
    
    Create a new Feature with a Map of attributes, an id, and a Schema.
    Schema s = new Schema('widgets', [['name','string'],['price','float']]) Feature f = new Feature(['name': 'anvil', 'price': 100.0], '1', s)
    
    Parameters:
    attributes - A Map of name value pairs
    id - A String identifier
    schema - The Schema
  - Feature(java.util.List attributes, java.lang.String id, Schema schema)
    
    Create a new Feature with a List of values, an id, and a Schema. The List of values must be in the same order as the Schema's fields.
    Schema s = new Schema('widgets', [['name','string'],['price','float']]) Feature f = new Feature(['anvil', 100.0], '1', s)
    
    Parameters:
    attributes - A List of attribute values
    id - A String identifier
    schema - The Schema
  - Feature(Map attributes, java.lang.String id)
    
    Create a new Feature with a Map of Attributes and an Id. The Schema is inferred from the attribute values.
    Feature f = new Feature(['name': 'anvil', 'price': 100.0], 'widgets.1')
    
    Parameters:
    atributes - A Map of name value pairs
    id - The string identifer
- Method Detail
  - java.lang.Object get(java.lang.String name)
    
    Get a value by Field name.
    String name = feature.get("name")
    
    Parameters:
    name - The Field name
    Returns:
    The attribute value
  - java.lang.Object get(Field field)
    
    Get a value by a Field.
    Field fld = feature.schema.get("name")
    
    String name = feature.get(fld)
    
    Parameters:
    name - The Field name
    Returns:
    The attribute value
  - java.lang.Object getAt(java.lang.String name)
    
    Get a value by Field name. This method supports a the following syntax:
    String name = feature["name"]
    
    Parameters:
    name - The Field name
    Returns:
    The attribute value
  - java.lang.Object getAt(Field field)
    
    Get a value by Field. This method supports a the following syntax:
    Field fld = feature.schema.get("name")
    
    String name = feature[fld]
    
    Parameters:
    name - The Field
    Returns:
    The attribute value
  - Map getAttributes()
    
    Get a Map of all attributes
    Returns:
    A Map of all attributes
  - Bounds getBounds()
    
    The Bounds of the Feature's Geometry.
    Parameters:
    The - Bounds of the Feature's Geometry
  - Geometry getGeom()
    
    Get the Feature's Geometry
    Returns:
    The Feature's Geometry
  - java.lang.String getId()
    
    Get the Feature's ID
    Returns:
    The Feature's ID
  - void putAt(java.lang.String name, java.lang.Object value)
    
    Another way of setting a value. This method supports the following syntax:
    feature["name"] = "lighthouse"
    
    Parameters:
    name - The Field name
    value - The new value
  - void putAt(Field field, java.lang.Object value)
    
    Set a value
    Field fld = feature.schema.get("name")
    
    feature[fld] = "lighthouse"
    
    Parameters:
    name - The Field
    value - The new attribute value
  - void set(java.lang.String name, java.lang.Object value)
    
    Set a value.
    feature.set("name") = "lighthouse"
    
    Parameters:
    name - The Field name
    value - The new attribute value
  - void set(Field field, java.lang.Object value)
    
    Set a value.
    Field fld = feature.schema.get("name")
    
    feature.set(fld) = "lighthouse"
    
    Parameters:
    name - The Field
    value - The new attribute value
  - void set(Feature f)
    
    Set the values of this Feature based on values from another Feature
    Parameters:
    f - The other Feature whose values we want
  - void set(Map attributes)
    
    Set the values of this Feature based on values from a Map
    Parameters:
    attributes - A Map of values
  - void setGeom(Geometry geom)
    
    Set the Feature's Geometry
    Parameters:
    geom - The new Geometry
  - java.lang.String toString()
    
    The string representation
    Returns:
    The string representation

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class Feature

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

SimpleFeature f

Geometry geom

Layer layer

Schema schema

Constructor Detail

Feature(SimpleFeature f)

Feature(Map attributes, java.lang.String id, Schema schema)

Feature(java.util.List attributes, java.lang.String id, Schema schema)

Feature(Map attributes, java.lang.String id)

Method Detail

java.lang.Object get(java.lang.String name)

java.lang.Object get(Field field)

java.lang.Object getAt(java.lang.String name)

java.lang.Object getAt(Field field)

Map getAttributes()

Bounds getBounds()

Geometry getGeom()

java.lang.String getId()

void putAt(java.lang.String name, java.lang.Object value)

void putAt(Field field, java.lang.Object value)

void set(java.lang.String name, java.lang.Object value)

void set(Field field, java.lang.Object value)

void set(Feature f)

void set(Map attributes)

void setGeom(Geometry geom)

java.lang.String toString()