TableEntity Interface
public interface TableEntity
Interface requise pour les types d'entités de table. L’interface TableEntity déclare les méthodes getter et setter pour les propriétés d’entité courantes, et les méthodes de sérialisation et de désérialisation de toutes les propriétés d’entité à l’aide d’un mappage de propriétés. Créez des classes implémentant TableEntity pour personnaliser le stockage des propriétés, la récupération, la sérialisation et la désérialisation, et pour fournir une logique personnalisée supplémentaire pour une entité de table.
La bibliothèque cliente de stockage comprend deux implémentations de qui fournissent un TableEntity accès simple aux propriétés et la sérialisation :
DynamicTableEntityTableEntity implémente et fournit un mappage de propriétés simple pour stocker et récupérer des propriétés. Utilisez un DynamicTableEntity pour un accès simple aux propriétés d’entité quand seul un sous-ensemble de propriétés est retourné (par exemple, par une clause select dans une requête) ou pour quand votre requête peut retourner plusieurs types d’entités avec des propriétés différentes. Vous pouvez également utiliser ce type pour effectuer des mises à jour de tables en bloc d'entités hétérogènes sans perdre les informations sur les propriétés.
TableServiceEntity est une implémentation de qui utilise un comportement de TableEntity sérialisation et de désérialisation basé sur la réflexion dans ses méthodes et . TableServiceEntity- les classes dérivées avec des méthodes qui suivent une convention pour les types et le nommage sont sérialisées et désérialisées automatiquement.
Toute classe qui implémente peut tirer parti du comportement automatique de sérialisation et de désérialisation basé sur la réflexion dans en TableServiceEntity appelant les méthodes statiques TableEntity dans et dans . La classe doit fournir des méthodes qui suivent la convention de type et de nommage à sérialiser et à désérialiser automatiquement. Quand une méthode getter et une méthode setter sont trouvées pour un nom de propriété et un type de données donnés, la méthode appropriée est appelée automatiquement pour sérialiser ou désérialiser les données. Le code de réflexion recherche les méthodes getter et setter par paires du formulaire
et
où PropertyName est un nom de propriété pour l’entité table et type est un type Java compatible avec le type de données EDM de la propriété. Consultez le tableau de la description de la classe pour TableServiceEntity obtenir une carte des types de propriétés à leurs équivalents Java. L’annotation StoreAs peut être appliquée avec un attribut pour spécifier un nom de propriété pour la réflexion sur les méthodes getter et setter qui ne suivent pas la convention de nom de propriété. Les noms de méthode et l’attribut des StoreAs annotations respectent la casse pour la correspondance des noms de propriétés avec réflexion. Utilisez l’annotation Ignore pour empêcher les méthodes d’être utilisées par la réflexion pour la sérialisation et la désérialisation automatiques. Notez que les noms « PartitionKey », « RowKey », « Timestamp » et « Etag » sont réservés et seront ignorés s’ils sont définis avec l’annotation StoreAs dans une sous-classe qui utilise les méthodes de réflexion.
Résumé de la méthode
Modificateur et type | Méthode et description |
---|---|
String |
getEtag()
Obtient la valeur ETag à vérifier pour l’entité. Cette valeur est utilisée pour déterminer si l’entité de table a changé depuis sa dernière lecture à partir du stockage Microsoft Azure. Le client ne peut pas mettre à jour cette valeur sur le service. |
String |
getPartitionKey()
Obtient la valeur PartitionKey de l’entité. |
String |
getRowKey()
Obtient la valeur RowKey de l’entité. |
Date |
getTimestamp()
Obtient l’horodatage de l’entité. Le serveur gère la valeur de Timestamp, qui ne peut pas être modifiée. |
void |
readEntity(HashMap<String, EntityProperty> properties, OperationContext opContext)
Remplit une instance de l’objet implémentant TableEntity à l’aide du paramètre properties spécifié, qui représente une carte des noms de propriétés aux EntityProperty valeurs de type données. |
void |
setEtag(String etag)
Définit la valeur ETag à vérifier pour l’entité. Cette valeur est utilisée pour déterminer si l’entité de table a changé depuis sa dernière lecture à partir du stockage Microsoft Azure. Le client ne peut pas mettre à jour cette valeur sur le service. |
void |
setPartitionKey(String partitionKey)
Définit la valeur PartitionKey pour l’entité. |
void |
setRowKey(String rowKey)
Définit la valeur RowKey pour l’entité. |
void |
setTimestamp(Date timeStamp)
Définit la valeur Timestamp pour l’entité. Notez que l’horodatage est une propriété en lecture seule sur le service et ne doit pas être défini par l’utilisateur. |
HashMap<String, Entity |
writeEntity(OperationContext opContext)
Retourne un mappage des noms de propriétés aux EntityProperty valeurs typées de données qui représente le contenu sérialisé de l’entité table instance. |
Détails de la méthode
getEtag
public String getEtag()
Obtient la valeur ETag à vérifier pour l’entité. Cette valeur est utilisée pour déterminer si l’entité de table a changé depuis sa dernière lecture à partir du stockage Microsoft Azure. Le client ne peut pas mettre à jour cette valeur sur le service.
Returns:
String
qui représente l’ETag de l’entité.getPartitionKey
public String getPartitionKey()
Obtient la valeur PartitionKey de l’entité.
Returns:
String
qui représente la valeur PartitionKey de l’entité.getRowKey
public String getRowKey()
Obtient la valeur RowKey de l’entité.
Returns:
String
qui représente la valeur RowKey de l’entité.getTimestamp
public Date getTimestamp()
Obtient l’horodatage de l’entité. Le serveur gère la valeur de Timestamp, qui ne peut pas être modifiée.
Returns:
java.util.Date
qui représente la valeur Timestamp de l’entité.readEntity
public void readEntity(HashMap
Remplit une instance de l’objet implémentant TableEntity à l’aide du paramètre properties spécifié, qui représente une carte des noms de propriétés aux EntityProperty valeurs de type données.
Parameters:
java.util.HashMap
de String
à EntityProperty des valeurs typées de données à utiliser pour remplir l’entité de table instance.
Throws:
setEtag
public void setEtag(String etag)
Définit la valeur ETag à vérifier pour l’entité. Cette valeur est utilisée pour déterminer si l’entité de table a changé depuis sa dernière lecture à partir du stockage Microsoft Azure. Le client ne peut pas mettre à jour cette valeur sur le service.
Parameters:
String
qui spécifie l’ETag à définir pour l’entité.
setPartitionKey
public void setPartitionKey(String partitionKey)
Définit la valeur PartitionKey pour l’entité.
Parameters:
String
qui spécifie la valeur PartitionKey à définir pour l’entité.
setRowKey
public void setRowKey(String rowKey)
Définit la valeur RowKey pour l’entité.
Parameters:
String
qui spécifie la valeur RowKey à définir pour l’entité.
setTimestamp
public void setTimestamp(Date timeStamp)
Définit la valeur Timestamp pour l’entité. Notez que l’horodatage est une propriété en lecture seule sur le service et ne doit pas être défini par l’utilisateur.
Parameters:
java.util.Date
qui spécifie la valeur d’horodatage à définir pour l’entité.
writeEntity
public HashMap
Retourne un mappage des noms de propriétés aux EntityProperty valeurs typées de données qui représente le contenu sérialisé de l’entité table instance.
Parameters:
Returns:
java.util.HashMap
noms de propriétés vers EntityProperty des String
valeurs typées de données représentant les propriétés de l’entité table.Throws:
S’applique à
Azure SDK for Java