collection_redesign.xmi

Amarok是一款在LINUX或其他类UNIX操作系统中运行的音频播放器软件。 经过两年开发后

          <UML:Parameter kind="return" xmi.id="14490" type="12609" />
         </UML:BehavioralFeature.parameter>
        </UML:Operation>
        <UML:Operation comment="update the title of this song. This method will return immediately and will not update the title if supportsTagUpdates() returns false." isSpecification="false" isLeaf="false" visibility="public" xmi.id="5766" isRoot="false" isAbstract="true" isQuery="false" name="setTitle" >
         <UML:BehavioralFeature.parameter>
          <UML:Parameter isSpecification="false" visibility="private" xmi.id="5767" value="" type="4736" name="newTitle" />
         </UML:BehavioralFeature.parameter>
        </UML:Operation>
        <UML:Operation comment="find out whether this song is deletable." isSpecification="false" isLeaf="false" visibility="public" xmi.id="6699" isRoot="false" isAbstract="true" isQuery="true" name="deletable" >
         <UML:BehavioralFeature.parameter>
          <UML:Parameter kind="return" xmi.id="14491" type="4396" />
         </UML:BehavioralFeature.parameter>
        </UML:Operation>
        <UML:Operation comment="Calling this method will remove the song from the underlying collection and from the filesystem. Client code should delete the instance after calling this method.

This method is a NOOP when deletable() returns false" isSpecification="false" isLeaf="false" visibility="public" xmi.id="6726" isRoot="false" isAbstract="true" isQuery="false" name="delete" >
         <UML:BehavioralFeature.parameter>
          <UML:Parameter kind="return" xmi.id="14492" type="4396" />
          <UML:Parameter comment="if true, the file is not deleted but moved to trash instead. If it is not possible to move it to trash because the underlying storage system does not support it, the file is directly deleted." isSpecification="false" visibility="private" xmi.id="6727" value="true" type="4396" name="moveToTrash" />
         </UML:BehavioralFeature.parameter>
        </UML:Operation>
        <UML:Operation isSpecification="false" isLeaf="false" visibility="public" xmi.id="8577" isRoot="false" isAbstract="true" isQuery="false" name="trackNumber" >
         <UML:BehavioralFeature.parameter>
          <UML:Parameter kind="return" xmi.id="14493" type="4393" />
         </UML:BehavioralFeature.parameter>
        </UML:Operation>
        <UML:Operation isSpecification="false" isLeaf="false" visibility="public" xmi.id="8610" isRoot="false" isAbstract="true" isQuery="false" name="cdNumber" >
         <UML:BehavioralFeature.parameter>
          <UML:Parameter kind="return" xmi.id="14494" type="4393" />
         </UML:BehavioralFeature.parameter>
        </UML:Operation>
        <UML:Operation comment="returns true if the collection that this song is stored in supports labels." isSpecification="false" isLeaf="false" visibility="public" xmi.id="5019" isRoot="false" isAbstract="true" isQuery="true" name="supportsLabels" >
         <UML:BehavioralFeature.parameter>
          <UML:Parameter kind="return" xmi.id="14495" type="4396" />
         </UML:BehavioralFeature.parameter>
        </UML:Operation>
        <UML:Operation comment="get the labels for this song, if any. It will return an empty list if no labels were defined or the collection of this song does not support labels." isSpecification="false" isLeaf="false" visibility="public" xmi.id="5048" isRoot="false" isAbstract="true" isQuery="false" name="labels" >
         <UML:BehavioralFeature.parameter>
          <UML:Parameter kind="return" xmi.id="14496" type="4754" />
         </UML:BehavioralFeature.parameter>
        </UML:Operation>
        <UML:Operation isSpecification="false" isLeaf="false" visibility="public" xmi.id="11560" isRoot="false" isAbstract="true" isQuery="false" name="setLabels" >
         <UML:BehavioralFeature.parameter>
          <UML:Parameter isSpecification="false" visibility="private" xmi.id="11561" value="" type="4754" name="labels" />
         </UML:BehavioralFeature.parameter>
        </UML:Operation>
        <UML:Operation isSpecification="false" isLeaf="false" visibility="public" xmi.id="11638" isRoot="false" isAbstract="true" isQuery="false" name="removeLabel" >
         <UML:BehavioralFeature.parameter>
          <UML:Parameter kind="return" xmi.id="14497" type="4396" />
          <UML:Parameter isSpecification="false" visibility="private" xmi.id="11639" value="" type="4736" name="label" />
         </UML:BehavioralFeature.parameter>
        </UML:Operation>
        <UML:Operation isSpecification="false" isLeaf="false" visibility="public" xmi.id="11717" isRoot="false" isAbstract="true" isQuery="false" name="addLabel" >
         <UML:BehavioralFeature.parameter>
          <UML:Parameter kind="return" xmi.id="14498" type="4396" />
          <UML:Parameter isSpecification="false" visibility="private" xmi.id="11718" value="" type="4736" name="label" />
         </UML:BehavioralFeature.parameter>
        </UML:Operation>
       </UML:Classifier.feature>
      </UML:Interface>
      <UML:Interface stereotype="4410" isSpecification="false" isLeaf="false" visibility="public" namespace="1" xmi.id="5301" isRoot="false" isAbstract="true" name="Album" >
       <UML:Classifier.feature>
        <UML:Operation comment="get all the tracks of the album. The tracks will be ordered by ascending CD number first, ascending track number second.

NOTE: what about albums which span multiple collections? We would need an asynchronous method, otherwise this method could block for a long time." isSpecification="false" isLeaf="false" visibility="public" xmi.id="5413" isRoot="false" isAbstract="true" isQuery="false" name="tracks" >
         <UML:BehavioralFeature.parameter>
          <UML:Parameter kind="return" xmi.id="14499" type="4742" />
         </UML:BehavioralFeature.parameter>
        </UML:Operation>
        <UML:Operation isSpecification="false" isLeaf="false" visibility="public" xmi.id="5433" isRoot="false" isAbstract="true" isQuery="false" name="albumImage" />
        <UML:Operation isSpecification="false" isLeaf="false" visibility="public" xmi.id="5453" isRoot="false" isAbstract="true" isQuery="true" name="name" >
         <UML:BehavioralFeature.parameter>
          <UML:Parameter kind="return" xmi.id="14500" type="4736" />
         </UML:BehavioralFeature.parameter>
        </UML:Operation>
        <UML:Operation isSpecification="false" isLeaf="false" visibility="public" xmi.id="8006" isRoot="false" isAbstract="true" isQuery="false" name="setAlbumImage" />
       </UML:Classifier.feature>
      </UML:Interface>
      <UML:Interface stereotype="4410" isSpecification="false" isLeaf="false" visibility="public" namespace="1" xmi.id="5320" isRoot="false" isAbstract="true" name="Artist" >
       <UML:Classifier.feature>
        <UML:Operation isSpecification="false" isLeaf="false" visibility="public" xmi.id="5339" isRoot="false" isAbstract="true" isQuery="false" name="similarArtists" />
        <UML:Operation isSpecification="false" isLeaf="false" visibility="public" xmi.id="5358" isRoot="false" isAbstract="true" isQuery="false" name="albums" />
        <UML:Operation isSpecification="false" isLeaf="false" visibility="public" xmi.id="5494" isRoot="false" isAbstract="true" isQuery="true" name="name" >
         <UML:BehavioralFeature.parameter>
          <UML:Parameter kind="return" xmi.id="14501" type="4736" />
         </UML:BehavioralFeature.parameter>
        </UML:Operation>
        <UML:Operation isSpecification="false" isLeaf="false" visibility="public" xmi.id="8297" isRoot="false" isAbstract="true" isQuery="false" name="allSongs" >
         <UML:BehavioralFeature.parameter>
          <UML:Parameter kind="return" xmi.id="14502" type="4742" />
         </UML:BehavioralFeature.parameter>
        </UML:Operation>
        <UML:Operation comment="Get the user's favorite songs from this artist" isSpecification="false" isLeaf="false" visibility="public" xmi.id="8328" isRoot="false" isAbstract="true" isQuery="false" name="favoriteSongs" >
         <UML:BehavioralFeature.parameter>
          <UML:Parameter kind="return" xmi.id="14503" type="4742" />
          <UML:Parameter comment="The maximum number of favorite songs to return." isSpecification="false" visibility="private" xmi.id="8329" value="" type="4393" name="count" />
         </UML:BehavioralFeature.parameter>
        </UML:Operation>
       </UML:Classifier.feature>
      </UML:Interface>
      <UML:Interface stereotype="4410" comment="This abstract class encapsulates and extends the collection folders of Amarok 1.x. The idea is to allow the user to move/copy from one collection type to another, e.g. from the local collection to an ipod or from a DAAP share to the local collection or to a media device.

It should be possible to reuse this code when implementing the copy mechanism for the media device browser." isSpecification="false" isLeaf="false" visibility="public" namespace="m1" xmi.id="7051" isRoot="false" isAbstract="true" name="CollectionLocation" >
       <UML:Classifier.feature>
        <UML:Operation comment="pretty name of this collection location for display purposes." isSpecification="false" isLeaf="false" visibility="public" xmi.id="7079" isRoot="false" isAbstract="true" isQuery="true" name="prettyName" >
         <UML:BehavioralFeature.parameter>
          <UML:Parameter kind="return" xmi.id="14504" type="4736" />
         </UML:BehavioralFeature.parameter>
        </UML:Operation>
        <UML:Operation comment="copy a file to a destination in this collection location. Will return true if the file could be copied successfully, false otherwise.
Note: the method will return true even if the original file could not be deleted as long as the file was copied successfully.

Note: implementations are free to ignore the relative path if the underlying collection requires it.

TODO:
figure out how the CollectionLocation can easily access the song. Add a toStream() method to Song???" isSpecification="false" isLeaf="false" visibility="public" xmi.id="7136" isRoot="false" isAbstract="true" isQuery="false" name="copy" >
         <UML:BehavioralFeature.parameter>
          <UML:Parameter kind="return" xmi.id="14505" type="4396" />
          <UML:Parameter comment="the original file to be copied to the new location." isSpecification="false" visibility="private" xmi.id="7137" value="" type="4892" name="originalFile" />
          <UML:Parameter comment="The relative path to copy the file to. This includes directories (if any) below the root of the collection location and the full destination filename" isSpecification="false" visibility="private" xmi.id="7166" value="" type="4736" name="relativeDestinationPath" />
          <UML:Parameter comment="attempt to delete the original file (thereby implementing a move operation).
Note: the original filename will not be deleted if originalFile->deletable() returns false. The move operation will still succeed though." isSpecification="false" visibility="private" xmi.id="7223" value="false" type="4396" name="deleteOriginal" />
         </UML:BehavioralFeature.parameter>
        </UML:Operation>
       </UML:Classifier.feature>
      </UML:Interface>
      <UML:Interface stereotype="4410" isSpecification="false" isLeaf="false" visibility="public" namespace="1" xmi.id="11878" isRoot="false" isAbstract="true" name="TagUpdater" >
       <UML:Classifier.feature>
        <UML:Operation isSpecification="false" isLeaf="false" visibility="public" xmi.id="11919" isRoot="false" isAbstract="true" isQuery="false" name="setAlbum" >
         <UML:BehavioralFeature.parameter>
          <UML:Parameter isSpecification="false" visibility="private" xmi.id="11920" value="" type="4736" name="album" />