Che cos'è una classe di contratto e come viene utilizzata

Question

Nella Guida aggiornata per Android Dev, la documentazione per i fornitori di contenuti contiene una sezione intitolata Contract Classes. Anche se esiste un collegamento a un esempio per Contatti, non è stato immediatamente chiaro cos'è una Classe di contratto e come posso crearne una per il mio Content Provider personalizzato

Apprezzerei qualche aiuto su questo.

Grazie!

Answer 1

Una classe contratto definisce le costanti che aiutano applicazioni funzionino con l'URI contenuto, i nomi delle colonne, le azioni intenti, e altre caratteristiche di un fornitore di contenuti. Le classi di contratto non sono incluse automaticamente con un fornitore; lo sviluppatore del provider deve definirli e quindi renderli disponibili ad altri sviluppatori.

È possibile creare la propria classe di contratto e definire alcune costanti lì. Ad esempio, i nomi delle colonne che in seguito sarà possibile chiamare in codice che rende le query al database, ecc

Bell'esempio di come classe contratto viene utilizzata vedere questa discussione Android - How do I load a contact Photo?

Answer 2

Contract è un contenitore per le costanti che definiscono i nomi per URI tavoli e colonne. Fornisce anche le stesse costanti su tutte le altre classi nello stesso pacchetto.

Answer 3

Che cos'è una classe di contratto?

Una classe contratto è una classe publicfinal che contiene le definizioni costanti per l'URI, i nomi delle colonne, tipi MIME, e altri meta-dati sulla ContentProvider. Può anche contenere i metodi di supporto static per manipolare gli URI.

Perché viene utilizzato?

1. La Classe contratto prevede un contratto tra il fornitore di contenuti e altre applicazioni. Assicura che il vostro fornitore di contenuti possibile accedere correttamente anche se ci sono cambiamenti ai valori effettivi di URI, i nomi delle colonne ecc
2. Dal momento che fornisce nomi mnemonici per le sue costanti, gli sviluppatori sono meno probabilità di utilizzare valori non corretti per nomi di colonne o URI.
3. È facile rendere disponibile ai client la documentazione Javadoc che desidera utilizzare il proprio provider di contenuti.

Come viene utilizzato?

Ecco uno snippet di classe Contract di esempio progettato per un'app meteo contenente due tabelle: tabella meteo e tabella posizione. I commenti e alcuni metodi vengono saltati per mantenerlo piccolo. Generalmente dovrebbe essere ben commentato.

public class WeatherContract { 

    public static final String CONTENT_AUTHORITY = 
      "com.example.android.sunshine.app"; 
    public static final Uri BASE_CONTENT_URI = 
      Uri.parse("content://" + CONTENT_AUTHORITY); 
    public static final String PATH_WEATHER = "weather"; 
    public static final String PATH_LOCATION = "location"; 

    /**Inner class that defines the table contents of the location table. */ 
    public static final class LocationEntry implements BaseColumns { 
     public static final String TABLE_NAME = "location"; 
     public static final String COLUMN_LOCATION_SETTING = "location_setting"; 
     public static final String COLUMN_CITY_NAME = "city_name"; 
     public static final String COLUMN_COORD_LAT = "coord_lat"; 
     public static final String COLUMN_COORD_LONG = "coord_long"; 

     public static final Uri CONTENT_URI = 
       BASE_CONTENT_URI.buildUpon().appendPath(PATH_LOCATION).build(); 

     // Custom MIME types 
     public static final String CONTENT_TYPE = 
       ContentResolver.CURSOR_DIR_BASE_TYPE + 
         "/" + CONTENT_AUTHORITY + "/" + PATH_LOCATION; 

     public static final String CONTENT_ITEM_TYPE = 
       ContentResolver.CURSOR_ITEM_BASE_TYPE + 
         "/" + CONTENT_AUTHORITY + "/" + PATH_LOCATION; 

     // Helper method 
     public static Uri buildLocationUri(long id) { 
      return ContentUris.withAppendedId(CONTENT_URI, id); 
     } 
    } 


    /** Inner class that defines the table contents of the weather table. */ 
    public static final class WeatherEntry implements BaseColumns { 

     public static final String TABLE_NAME = "weather"; 

     public static final String COLUMN_LOC_KEY = "location_id"; 
     public static final String COLUMN_DATE = "date"; 
     public static final String COLUMN_WEATHER_ID = "weather_id"; 
     public static final String COLUMN_SHORT_DESC = "short_desc"; 
     public static final String COLUMN_MIN_TEMP = "min"; 
     public static final String COLUMN_MAX_TEMP = "max"; 
     public static final String COLUMN_HUMIDITY = "humidity"; 
     public static final String COLUMN_PRESSURE = "pressure"; 
     public static final String COLUMN_WIND_SPEED = "wind"; 
     public static final String COLUMN_DEGREES = "degrees"; 

     public static final Uri CONTENT_URI = 
       BASE_CONTENT_URI.buildUpon().appendPath(PATH_WEATHER).build(); 

     public static final String CONTENT_TYPE = 
       ContentResolver.CURSOR_DIR_BASE_TYPE + "/" + CONTENT_AUTHORITY + 
         "/" + PATH_WEATHER; 

     public static final String CONTENT_ITEM_TYPE = 
       ContentResolver.CURSOR_ITEM_BASE_TYPE + "/" + CONTENT_AUTHORITY + 
         "/" + PATH_WEATHER; 

     // Helper method. 
     public static Uri buildWeatherUri(long id) { 
      return ContentUris.withAppendedId(CONTENT_URI, id); 
     } 

     . 
     . 
     . 
    } 
}