2.3.2.2 CF-Java: Accés a les dades

Guardar dades

Com acabem de comentar, accedim a tot un document dins d'una col·lecció.

Per a guardar dades, ens podem plantejar 3 operacions d'escriptura sobre el document:

• Sobreescriure'l tot: ho farem amb el mètode set()
• Esborrar-lo tot: amb el mètode delete()
• Modificar-lo: amb el mètode update()

Excepte per esborrar, per a les altres operacions ens fa falta saber l'estructura del document. Per això tant mètode set() com el mètode update() accepten com a paràmetre no una única dada, sinó una estructura que puga arribar a reflectir el document. Acceptaran com a paràmetre un Map<String, Object>, on podrem col·locar les claus i els valors de tots els membres del document. Cada valor pot ser dels tipus que vam practicar en el punt anterior: string, number, boolean, array, map, ...

La manera de col·locar un element en una estructura Map<> és amb el mètode put(), que acceptarà dos paràmetres: la clau i el valor.

En el següent exemple. quan s'apreta el botó d'enviar (baix a la dreta) es guardarà el contingut del quadre de text usuari que està dalt i el de missatge que està baix. Però observeu que estem utilitzant el mètode set() i per tant matxacaríem el que ja teníem contruït (el nom del xat i la subcol·lecció de missatges). Per tant US ACONSELLE QUE NO EXECUTEU EL QUE VE A CONTINUACIÓ

public void actionPerformed(ActionEvent e) {
		if (e.getSource() == enviar) {
			// Exemple de guardar dades en Cloud Firestore
            // Per a guardar dades. Sobre /Xats/XatProva i després sobre /Xats/Xat1
            Firestore database = FirestoreClient.getFirestore();
			DocumentReference docXatProva = database.collection("Xats").document("XatProva");

			Map<String, Object> dades = new HashMap<>();
			dades.put("ultimUsuari",usuari.getText());
			dades.put("ultimMissatge",missatge.getText());
			
			docXatProva.set(dades);
			
		}
	}

Aquest seria el resultat, creant-se el document amb les 2 clau-valor, i havent matxacat el que hi havia

En realitat els mètodes set(), delete() i update() tornen un valor, que és un ApiFuture<WriteResult>, que permet averiguar com ha anat l'actualització de les dades. D'aquest ApiFuture<> podem obtenir el moment en què s'ha confirmat l'actualització, però tranctant-lo perquè pot donar error.

Ampliem l'exemple anterior en què utilitzàvem el set() per a comprovar el que comentem, senzillament mostrant el moment en què s'ha actualitzat. US ACONSELLE QUE NO EXECUTEU EL QUE VE A CONTINUACIÓ

public void actionPerformed(ActionEvent e) {
		if (e.getSource() == enviar) {
			// Exemple de guardar dades en Cloud Firestore
            // Per a guardar dades. Sobre /Xats/XatProva i després sobre /Xats/Xat1
            Firestore database = FirestoreClient.getFirestore();
			DocumentReference docXatProva = database.collection("Xats").document("XatProva");

			Map<String, Object> dades = new HashMap<>();
			dades.put("ultimUsuari",usuari.getText());
			dades.put("ultimMissatge",missatge.getText());		
			
			ApiFuture<WriteResult> result = docXatProva.set(dades);
			try {
				System.out.println("Update time : " + result.get().getUpdateTime());
			} catch (InterruptedException e1) {
				// TODO Auto-generated catch block
				e1.printStackTrace();
			} catch (ExecutionException e1) {
				// TODO Auto-generated catch block
				e1.printStackTrace();
			}
			
		}
	}

Si veiem la consola d'eixida d'Eclipse veurem en negre al final com ha imprés el moment de la confirmació.

Aprofitem per comentar els avisos que ens han arribat. A les 4 primeres línies no els donarem importància. A partir de la quarta ens avisa ens falta alguna cosa que properament podria causar que fallara el grograma, i és el tractament de les dates. En el nostre exemple no cal que ens preocupem, perquè no guardem dates, i en els exercicis les guardem com un long.

En els exemples anterior, en cas d'haver-se executat hauran matxacat el document XatProva i això era per haver utilitzat el mètode set() .

Anem a canviar-lo pel mètode update(), en què senzillament afegirà (i si és necessari matxacarà) les dades que proporcionem, però mantindrà les altres. AQUEST EXEMPLE SÍ QUE EL PODEU FER

public void actionPerformed(ActionEvent e) {
		if (e.getSource() == enviar) {
			// Exemple de guardar dades en Cloud Firestore
            // Per a guardar dades. Sobre /Xats/XatProva i després sobre /Xats/Xat1
            Firestore database = FirestoreClient.getFirestore();
			DocumentReference docXatProva = database.collection("Xats").document("XatProva");

			Map<String, Object> dades = new HashMap<>();
			dades.put("ultimUsuari",usuari.getText());
			dades.put("ultimMissatge",missatge.getText());
			
			docXatProva.update(dades);
			
		}
	}

conservarem tant el camp nomXat com la col·lecció missatges

Recuperar dades

Com en el cas del Realtime Database, ens plantegem dos casos:

• Una única lectura
• Un listener que es quede escoltant per si hi ha canvis

Com comprovarem, queda més senzilla la lectura única en el cas de Cloud Firestore.

Lectura única

Per a fer una lectura única utilitzarem el mètode get() sobre una referència al document que volem llegir. El resultat ens ve en un ApiFuture<DocumentSnapshot>, que com es veu és una còpia de les dades en una interface ApiFutute, indicant que la tindrem disponible en un futur. Sobre l'anterior farem get() per a obtenir aquesta còpia (serà un objecte). I sobre ella podrem fer:

• getData() per a obtenir tot el document en un Map<String,Object>
• getId() per a obtenir el nom del document
• get(nomClau) per a obtenir directament el valor d'una clau del document
• getString(nomClau) per a obtenir el valor de la clau en forma de string
• getDouble(nomClau) per a obtenir el valor de la clau en forma de double
• ...

L'exemple d'única lectura el farem per a posar el títol de l'aplicació, com en l'exemple del Realtime Database. Prèviament, des de la consola de Firebase ja havíem creat la parella clau-valor: nomXat: Xat Cloud Firestore, dins del document XatProva. Si pels exemples anteriors (els que havia marcat en roig que no us aconsellava fer) heu perdut aquesta parella, és el moment de crear-la de nou:

Ara sí que haurem d'anar amb compte en el moment de guardar les dades. Si utilitzem el mètode set() matxacarem el document anterior (amb el nom del xat). Per tant, a partir d'ara ens convindrà utilitzar el mètode update(). Ho tornarem a especificar en el moment de fer aquesta escriptura.

I aquestes seran les sentències per a posar el títol de l'aplicació:

		// Exemple de lectura única: senzillament sobre un ApiFuture i sobre ell get()
		// Per a posar el títol. Sobre /Xats/XatProva/nomXat
		Firestore database = FirestoreClient.getFirestore();
		DocumentReference docRef = database.collection("Xats").document("XatProva");
		ApiFuture<DocumentSnapshot> future = docRef.get();
		String nomXat = future.get().getString("nomXat");
		this.setTitle(nomXat);

I ací tenim el resultat:

Listener que es queda escoltant: addSnapshotListener()

De forma paral·lela al Realtime Database, si volem rebre una notificació de quan hi haja un canvi en el document que ens interessa, sobRe una referència a aquest document ens muntarem un listener, en aquest cas amb el mètode addSnapshotListener(). Al mètode onEvent() que s'ha de sobreescriure arribarà un paràmetre de tipus DocumentSnapshot, que serà una còpia del document. Com en el cas anterior podrem fer sobre ell un getData() per a obtenir tot el document, getString(nomClau) per a obtenir el valor de la clau com un string, etc.

En el nostre exemple, de moment l'utilitzem tant per a posar l'últim missatge com per a anar omplit l'àrea central amb el xat. Però com havíem comentat abans, hem de cuidar de no matxacar tot el document per a noo perdre el títol del xat. Per tant, l'acció que farem en apretar el botó per a enviar el missatge no serà set() sinó update(). Per si de cas havíeu fet els exemples que us havia aconsellat que no féreu, ací teniu una altra vegada el codi correcte:

public void actionPerformed(ActionEvent e) {
		if (e.getSource() == enviar) {
			// Exemple de guardar dades en Cloud Firestore
			// Per a guardar dades. Sobre /Xats/XatProva i després sobre /Xats/Xat1
			Firestore database = FirestoreClient.getFirestore();
			DocumentReference docXatProva = database.collection("Xats").document("XatProva");

			Map<String, Object> dades = new HashMap<>();
			dades.put("ultimUsuari",usuari.getText());
			dades.put("ultimMissatge",missatge.getText());		
			
			docXatProva.update(dades);
			
		}
	}

I ara sí el addSnapshotListener():

		// Exemple de listener de lectura contínua addSnapshotListener()
		// Per a posar l'últim missatge registrat. Sobre /Xats/XatProva/ultimUsuari i /Xats/XatProva/ultimMissatge
		docRef.addSnapshotListener(new EventListener<DocumentSnapshot>() {
		  @Override
		  public void onEvent(@Nullable DocumentSnapshot snapshot,
		                      @Nullable FirestoreException e) {
		    if (e != null) {
		      System.err.println("Listen failed: " + e);
		      return;
		    }

		    if (snapshot != null && snapshot.exists()) {
		      ultimMissatge.setText(snapshot.getString("ultimMissatge"));
		      area.append(snapshot.getString("ultimUsuari") + ": " + snapshot.getString("ultimMissatge") + "\n");
		    } else {
		      System.out.print("Current data: null");
		    }
		  }
		});

En aquest exemple tenim el tractament de possibles errors, com que no s'accedeix al document, o aquest és nul.

Observeu com la primera lectura també la fa, del que hi haja guardat en un principi. En la imatge es mostra el moment d'afegir un segon missatge: