TableEntity Interfaz

Paquete:

com.microsoft.azure.storage.table

public interface TableEntity

Interfaz necesaria para los tipos de entidad de tabla. La TableEntity interfaz declara métodos getter y establecedor para las propiedades de entidad comunes, y métodos para la serialización y deserialización de todas las propiedades de entidad mediante un mapa de propiedades. Cree clases que implementen TableEntity para personalizar el almacenamiento de propiedades, la recuperación, la serialización y la deserialización, y para proporcionar lógica personalizada adicional para una entidad de tabla.

La biblioteca cliente de Storage incluye dos implementaciones de TableEntity que proporcionan acceso y serialización de propiedades simples:

DynamicTableEntityTableEntity implementa y proporciona un mapa de propiedades simple para almacenar y recuperar propiedades. Use para DynamicTableEntity un acceso sencillo a las propiedades de entidad cuando solo se devuelva un subconjunto de propiedades (por ejemplo, mediante una cláusula select en una consulta) o cuando la consulta pueda devolver varios tipos de entidad con propiedades diferentes. También puede utilizar este tipo para realizar de forma masiva actualizaciones de tabla de entidades heterogéneas sin perder información de la propiedad.

TableServiceEntity es una implementación de que usa el comportamiento de TableEntity serialización y deserialización basado en reflexión en sus métodos y . TableServiceEntity-las clases derivadas con métodos que siguen una convención para los tipos y la nomenclatura se serializan y deserializan automáticamente.

Cualquier clase que implemente puede aprovechar las ventajas TableEntity de la serialización y deserialización automáticas basadas en reflexión en TableServiceEntity mediante la invocación de los métodos estáticos en y en . La clase debe proporcionar métodos que sigan el tipo y la convención de nomenclatura que se van a serializar y deserializar automáticamente. Cuando se encuentra un método captador y un método establecedor para un nombre de propiedad y un tipo de datos determinado, se invoca automáticamente el método adecuado para serializar o deserializar los datos. El código de reflexión busca métodos captadores y establecedores en pares del formulario.

y

donde PropertyName es un nombre de propiedad para la entidad de tabla y el tipo es un tipo de Java compatible con el tipo de datos EDM de la propiedad. Consulte la tabla de la descripción de la clase para obtener TableServiceEntity un mapa de tipos de propiedad a sus equivalentes de Java. La StoreAs anotación se puede aplicar con un atributo para especificar un nombre de propiedad para la reflexión en los métodos captadores y establecedores que no siguen la convención de nombre de propiedad. Los nombres de método y el atributo de las anotaciones distinguen mayúsculas de StoreAs minúsculas para buscar nombres de propiedad coincidentes con la reflexión. Use la Ignore anotación para evitar que la reflexión use métodos para la serialización y deserialización automáticas. Tenga en cuenta que los nombres "PartitionKey", "RowKey", "Timestamp" y "Etag" están reservados y se omitirán si se establecen con la StoreAs anotación en una subclase que usa los métodos de reflexión.

Resumen del método

Modificador y tipo	Método y descripción
String	getEtag() Obtiene el valor ETag que se va a comprobar para la entidad. Este valor se usa para determinar si la entidad de tabla ha cambiado desde que se leyó por última vez desde Microsoft Azure Storage. El cliente no puede actualizar este valor en el servicio.
String	getPartitionKey() Obtiene el valor PartitionKey de la entidad.
String	getRowKey() Obtiene el valor RowKey de la entidad.
Date	getTimestamp() Obtiene la marca de tiempo de la entidad. El servidor se encargará de administrar el valor Timestamp, así que no podrá modificarlo.
void	readEntity(HashMap<String, EntityProperty> properties, OperationContext opContext) Rellena una instancia del objeto que implementa TableEntity mediante el parámetro de propiedades especificado, que representa un mapa de nombres de propiedad a EntityProperty valores con tipo de datos.
void	setEtag(String etag) Establece el valor ETag para comprobar la entidad. Este valor se usa para determinar si la entidad de tabla ha cambiado desde que se leyó por última vez desde Microsoft Azure Storage. El cliente no puede actualizar este valor en el servicio.
void	setPartitionKey(String partitionKey) Establece el valor PartitionKey de la entidad.
void	setRowKey(String rowKey) Establece el valor RowKey de la entidad.
void	setTimestamp(Date timeStamp) Establece el valor timestamp de la entidad. Tenga en cuenta que la marca de tiempo es una propiedad de solo lectura en el servicio y el usuario no debe establecerla.
HashMap<String, EntityProperty>	writeEntity(OperationContext opContext) Devuelve un mapa de nombres de propiedad a EntityProperty valores con tipo de datos que representa el contenido serializado de la instancia de entidad de tabla.

Detalles del método

getEtag

public String getEtag()

Obtiene el valor ETag que se va a comprobar para la entidad. Este valor se usa para determinar si la entidad de tabla ha cambiado desde que se leyó por última vez desde Microsoft Azure Storage. El cliente no puede actualizar este valor en el servicio.

Returns:

que String representa la ETag de la entidad.

getPartitionKey

public String getPartitionKey()

Obtiene el valor PartitionKey de la entidad.

Returns:

que String representa el valor PartitionKey de la entidad.

getRowKey

public String getRowKey()

Obtiene el valor RowKey de la entidad.

Returns:

que String representa el valor RowKey de la entidad.

getTimestamp

public Date getTimestamp()

Obtiene la marca de tiempo de la entidad. El servidor se encargará de administrar el valor Timestamp, así que no podrá modificarlo.

Returns:

Objeto java.util.Date que representa el valor timestamp de la entidad.

readEntity

public void readEntity(HashMap properties, OperationContext opContext)

Rellena una instancia del objeto que implementa TableEntity mediante el parámetro de propiedades especificado, que representa un mapa de nombres de propiedad a EntityProperty valores con tipo de datos.

Parameters:

properties - de java.util.HashMapString en EntityProperty valores con tipo de datos que se van a usar para rellenar la instancia de entidad de tabla.

opContext - Objeto OperationContext utilizado para realizar un seguimiento de la ejecución de la operación.

Throws:

StorageException - Si se produce un error durante la operación.

setEtag

public void setEtag(String etag)

Establece el valor ETag para comprobar la entidad. Este valor se usa para determinar si la entidad de tabla ha cambiado desde que se leyó por última vez desde Microsoft Azure Storage. El cliente no puede actualizar este valor en el servicio.

Parameters:

etag - que String especifica la ETag que se va a establecer para la entidad.

setPartitionKey

public void setPartitionKey(String partitionKey)

Establece el valor PartitionKey de la entidad.

Parameters:

partitionKey - que String especifica el valor PartitionKey que se va a establecer para la entidad.

setRowKey

public void setRowKey(String rowKey)

Establece el valor RowKey de la entidad.

Parameters:

rowKey - que String especifica el valor RowKey que se va a establecer para la entidad.

setTimestamp

public void setTimestamp(Date timeStamp)

Establece el valor timestamp de la entidad. Tenga en cuenta que la marca de tiempo es una propiedad de solo lectura en el servicio y el usuario no debe establecerla.

Parameters:

timeStamp - que java.util.Date especifica el valor timestamp que se va a establecer para la entidad.

writeEntity

public HashMap writeEntity(OperationContext opContext)

Devuelve un mapa de nombres de propiedad a EntityProperty valores con tipo de datos que representa el contenido serializado de la instancia de entidad de tabla.

Parameters:

opContext - Objeto OperationContext utilizado para realizar un seguimiento de la ejecución de la operación.

Returns:

De java.util.HashMap nombres de String propiedad a EntityProperty valores con tipo de datos que representan las propiedades de la entidad de tabla.

Throws:

StorageException - Si se produce un error durante la operación.