Coverage Report - org.jaudiotagger.tag.id3.ID3v23FieldKey
 
Classes in this File Line Coverage Branch Coverage Complexity
ID3v23FieldKey
98%
62/63
N/A
0
 
 1  
 package org.jaudiotagger.tag.id3;
 2  
 
 3  
 import org.jaudiotagger.tag.id3.framebody.FrameBodyTXXX;
 4  
 import org.jaudiotagger.tag.id3.framebody.FrameBodyUFID;
 5  
 import org.jaudiotagger.tag.id3.framebody.FrameBodyWXXX;
 6  
 
 7  
 /**
 8  
  * List of known id3v23 metadata fields
 9  
  * <p/>
 10  
  * <p>These provide a mapping from the generic key to the underlying ID3v23frames. For example most of the Musicbrainz
 11  
  * fields are implemnted using a User Defined Text Info Frame, but with a different description key, so this
 12  
  * enum provides the link between the two.
 13  
  */
 14  42
 public enum ID3v23FieldKey
 15  
 {
 16  42
     ARTIST(ID3v23Frames.FRAME_ID_V3_ARTIST, Id3FieldType.TEXT),
 17  42
     ALBUM(ID3v23Frames.FRAME_ID_V3_ALBUM, Id3FieldType.TEXT),
 18  42
     TITLE(ID3v23Frames.FRAME_ID_V3_TITLE, Id3FieldType.TEXT),
 19  42
     TRACK(ID3v23Frames.FRAME_ID_V3_TRACK, Id3FieldType.TEXT),
 20  42
     YEAR(ID3v23Frames.FRAME_ID_V3_TYER, Id3FieldType.TEXT),
 21  42
     GENRE(ID3v23Frames.FRAME_ID_V3_GENRE, Id3FieldType.TEXT),
 22  42
     COMMENT(ID3v23Frames.FRAME_ID_V3_COMMENT, Id3FieldType.TEXT),
 23  42
     ALBUM_ARTIST(ID3v23Frames.FRAME_ID_V3_ACCOMPANIMENT, Id3FieldType.TEXT),
 24  42
     COMPOSER(ID3v23Frames.FRAME_ID_V3_COMPOSER, Id3FieldType.TEXT),
 25  42
     GROUPING(ID3v23Frames.FRAME_ID_V3_CONTENT_GROUP_DESC, Id3FieldType.TEXT),
 26  42
     DISC_NO(ID3v23Frames.FRAME_ID_V3_SET, Id3FieldType.TEXT),
 27  42
     BPM(ID3v23Frames.FRAME_ID_V3_BPM, Id3FieldType.TEXT),
 28  42
     ENCODER(ID3v23Frames.FRAME_ID_V3_ENCODEDBY, Id3FieldType.TEXT),
 29  42
     MUSICBRAINZ_ARTISTID(ID3v23Frames.FRAME_ID_V3_USER_DEFINED_INFO, FrameBodyTXXX.MUSIC_BRAINZ_ARTISTID, Id3FieldType.TEXT),
 30  42
     MUSICBRAINZ_RELEASEID(ID3v23Frames.FRAME_ID_V3_USER_DEFINED_INFO, FrameBodyTXXX.MUSIC_BRAINZ_ALBUMID, Id3FieldType.TEXT),
 31  42
     MUSICBRAINZ_RELEASEARTISTID(ID3v23Frames.FRAME_ID_V3_USER_DEFINED_INFO, FrameBodyTXXX.MUSIC_BRAINZ_ALBUM_ARTISTID, Id3FieldType.TEXT),
 32  42
     MUSICBRAINZ_TRACK_ID(ID3v23Frames.FRAME_ID_V3_UNIQUE_FILE_ID, FrameBodyUFID.UFID_MUSICBRAINZ, Id3FieldType.TEXT),
 33  42
     MUSICBRAINZ_DISC_ID(ID3v23Frames.FRAME_ID_V3_USER_DEFINED_INFO, FrameBodyTXXX.MUSIC_BRAINZ_DISCID, Id3FieldType.TEXT),
 34  42
     MUSICIP_ID(ID3v23Frames.FRAME_ID_V3_USER_DEFINED_INFO, FrameBodyTXXX.MUSICIP_ID, Id3FieldType.TEXT),
 35  42
     AMAZON_ID(ID3v23Frames.FRAME_ID_V3_USER_DEFINED_INFO, FrameBodyTXXX.AMAZON_ASIN, Id3FieldType.TEXT),
 36  42
     MUSICBRAINZ_RELEASE_STATUS(ID3v23Frames.FRAME_ID_V3_USER_DEFINED_INFO, FrameBodyTXXX.MUSICBRAINZ_ALBUM_STATUS, Id3FieldType.TEXT),
 37  42
     MUSICBRAINZ_RELEASE_TYPE(ID3v23Frames.FRAME_ID_V3_USER_DEFINED_INFO, FrameBodyTXXX.MUSICBRAINZ_ALBUM_TYPE, Id3FieldType.TEXT),
 38  42
     MUSICBRAINZ_RELEASE_COUNTRY(ID3v23Frames.FRAME_ID_V3_USER_DEFINED_INFO, FrameBodyTXXX.MUSICBRAINZ_ALBUM_COUNTRY, Id3FieldType.TEXT),
 39  42
     LYRICS(ID3v23Frames.FRAME_ID_V3_UNSYNC_LYRICS, Id3FieldType.TEXT),
 40  42
     IS_COMPILATION(ID3v23Frames.FRAME_ID_V3_IS_COMPILATION, Id3FieldType.TEXT),
 41  42
     ARTIST_SORT(ID3v23Frames.FRAME_ID_V3_ARTIST_SORT_ORDER_ITUNES, Id3FieldType.TEXT),
 42  42
     ALBUM_ARTIST_SORT(ID3v23Frames.FRAME_ID_V3_ALBUM_ARTIST_SORT_ORDER_ITUNES, Id3FieldType.TEXT),
 43  42
     ALBUM_SORT(ID3v23Frames.FRAME_ID_V3_ALBUM_SORT_ORDER_ITUNES, Id3FieldType.TEXT),
 44  42
     TITLE_SORT(ID3v23Frames.FRAME_ID_V3_TITLE_SORT_ORDER_ITUNES, Id3FieldType.TEXT),
 45  42
     COMPOSER_SORT(ID3v23Frames.FRAME_ID_V3_COMPOSER_SORT_ORDER_ITUNES, Id3FieldType.TEXT),
 46  42
     COVER_ART(ID3v23Frames.FRAME_ID_V3_ATTACHED_PICTURE, Id3FieldType.BINARY),
 47  42
     ISRC(ID3v23Frames.FRAME_ID_V3_ISRC, Id3FieldType.TEXT),
 48  42
     BARCODE(ID3v23Frames.FRAME_ID_V3_USER_DEFINED_INFO, FrameBodyTXXX.BARCODE, Id3FieldType.TEXT),
 49  42
     CATALO_NO(ID3v23Frames.FRAME_ID_V3_USER_DEFINED_INFO, FrameBodyTXXX.CATALOG_NO, Id3FieldType.TEXT),
 50  42
     RECORD_LABEL(ID3v23Frames.FRAME_ID_V3_PUBLISHER, Id3FieldType.TEXT),
 51  42
     LYRICIST(ID3v23Frames.FRAME_ID_V3_LYRICIST, Id3FieldType.TEXT),
 52  42
     CONDUCTOR(ID3v23Frames.FRAME_ID_V3_CONDUCTOR, Id3FieldType.TEXT),
 53  42
     REMIXER(ID3v23Frames.FRAME_ID_V3_REMIXED, Id3FieldType.TEXT),
 54  42
     MEDIA(ID3v23Frames.FRAME_ID_V3_MEDIA_TYPE, Id3FieldType.TEXT),
 55  42
     URL_OFFICIAL_RELEASE_SITE(ID3v23Frames.FRAME_ID_V3_USER_DEFINED_URL, FrameBodyWXXX.URL_OFFICIAL_RELEASE_SITE, Id3FieldType.TEXT),
 56  42
     URL_DISCOGS_RELEASE_SITE(ID3v23Frames.FRAME_ID_V3_USER_DEFINED_URL, FrameBodyWXXX.URL_DISCOGS_RELEASE_SITE, Id3FieldType.TEXT),
 57  42
     URL_WIKIPEDIA_RELEASE_SITE(ID3v23Frames.FRAME_ID_V3_USER_DEFINED_URL, FrameBodyWXXX.URL_WIKIPEDIA_RELEASE_SITE, Id3FieldType.TEXT),
 58  42
     URL_OFFICIAL_ARTIST_SITE(ID3v23Frames.FRAME_ID_V3_URL_ARTIST_WEB, Id3FieldType.TEXT),
 59  42
     URL_DISCOGS_ARTIST_SITE(ID3v23Frames.FRAME_ID_V3_USER_DEFINED_URL, FrameBodyWXXX.URL_DISCOGS_ARTIST_SITE, Id3FieldType.TEXT),
 60  42
     URL_WIKIPEDIA_ARTIST_SITE(ID3v23Frames.FRAME_ID_V3_USER_DEFINED_URL, FrameBodyWXXX.URL_WIKIPEDIA_ARTIST_SITE, Id3FieldType.TEXT),
 61  42
     LANGUAGE(ID3v23Frames.FRAME_ID_V3_LANGUAGE,Id3FieldType.TEXT),
 62  42
     KEY(ID3v23Frames.FRAME_ID_V3_INITIAL_KEY,Id3FieldType.TEXT),
 63  
     ;
 64  
 
 65  
     private String fieldName;
 66  
 
 67  
     private String frameId;
 68  
     private String subId;
 69  
     private Id3FieldType fieldType;
 70  
 
 71  
     /**
 72  
      * For usual metadata fields that use a data field
 73  
      *
 74  
      * @param frameId   the frame that will be used
 75  
      * @param fieldType of data atom
 76  
      */
 77  
     ID3v23FieldKey(String frameId, Id3FieldType fieldType)
 78  1260
     {
 79  1260
         this.frameId = frameId;
 80  1260
         this.fieldType = fieldType;
 81  
 
 82  1260
         this.fieldName = frameId;
 83  1260
     }
 84  
 
 85  
     /**
 86  
      * @param frameId   the frame that will be used
 87  
      * @param subId     the additional key required within the frame to uniquely identify this key
 88  
      * @param fieldType
 89  
      */
 90  
     ID3v23FieldKey(String frameId, String subId, Id3FieldType fieldType)
 91  714
     {
 92  714
         this.frameId = frameId;
 93  714
         this.subId = subId;
 94  714
         this.fieldType = fieldType;
 95  
 
 96  714
         this.fieldName = frameId + ":" + subId;
 97  714
     }
 98  
 
 99  
     /**
 100  
      * @return fieldtype
 101  
      */
 102  
     public Id3FieldType getFieldType()
 103  
     {
 104  0
         return fieldType;
 105  
     }
 106  
 
 107  
     /**
 108  
      * This is the frame identifier used to write the field
 109  
      *
 110  
      * @return
 111  
      */
 112  
     public String getFrameId()
 113  
     {
 114  97
         return frameId;
 115  
     }
 116  
 
 117  
     /**
 118  
      * This is the subfield used within the frame for this type of field
 119  
      *
 120  
      * @return subId
 121  
      */
 122  
     public String getSubId()
 123  
     {
 124  94
         return subId;
 125  
     }
 126  
 
 127  
     /**
 128  
      * This is the value of the key that can uniquely identifer a key type
 129  
      *
 130  
      * @return
 131  
      */
 132  
     public String getFieldName()
 133  
     {
 134  1
         return fieldName;
 135  
     }
 136  
 }