Content of file AudioFile.html
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Mon Apr 24 04:48:49 UTC 2023 -->
<title>AudioFile (blueMarine II :: Model 1.1-ALPHA-2-SNAPSHOT API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2023-04-24">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AudioFile (blueMarine II :: Model 1.1-ALPHA-2-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/AudioFile.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li><a href="#nested.class.summary">Nested</a> | </li>
<li><a href="#field.summary">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding"> </div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">it.tidalwave.bluemarine2.model.audio</a></div>
<h2 title="Interface AudioFile" class="title">Interface AudioFile</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><code><a href="http://blueMarine.tidalwave.it/bluemarine2-modules/it-tidalwave-bluemarine2-commons/apidocs/it/tidalwave/util/As.html?is-external=true" title="class or interface in it.tidalwave.util" class="externalLink">As</a></code>, <code><a href="../role/AudioFileSupplier.html" title="interface in it.tidalwave.bluemarine2.model.role">AudioFileSupplier</a></code>, <code><a href="http://blueMarine.tidalwave.it/bluemarine2-modules/it-tidalwave-bluemarine2-commons/apidocs/it/tidalwave/bluemarine2/util/Dumpable.html?is-external=true" title="class or interface in it.tidalwave.bluemarine2.util" class="externalLink">Dumpable</a></code>, <code><a href="../spi/Entity.html" title="interface in it.tidalwave.bluemarine2.model.spi">Entity</a></code>, <code>it.tidalwave.role.Identifiable</code>, <code><a href="../MediaItem.html" title="interface in it.tidalwave.bluemarine2.model">MediaItem</a></code>, <code><a href="../spi/PathAwareEntity.html" title="interface in it.tidalwave.bluemarine2.model.spi">PathAwareEntity</a></code></dd>
</dl>
<hr>
<object type="image/svg+xml" data="AudioFile.svg" style="max-width:60%;float:right;"></object>
<pre style="white-space:pre-wrap;">public interface <span class="typeNameLabel">AudioFile</span>
extends <a href="../MediaItem.html" title="interface in it.tidalwave.bluemarine2.model">MediaItem</a>, it.tidalwave.role.Identifiable</pre>
<div class="block">Represents an audio file. Maps the homonymous concept from the Music Ontology.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Fabrizio Giudici</dd>
<dt><span class="simpleTagLabel">Stereotype:</span></dt>
<dd>Datum</dd>
</dl>
</li>
</ul>
</div>
<div class="summary" style="clear:right;">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.it.tidalwave.util.As">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface it.tidalwave.util.<a href="http://blueMarine.tidalwave.it/bluemarine2-modules/it-tidalwave-bluemarine2-commons/apidocs/it/tidalwave/util/As.html?is-external=true" title="class or interface in it.tidalwave.util" class="externalLink">As</a></h3>
<code><a href="http://blueMarine.tidalwave.it/bluemarine2-modules/it-tidalwave-bluemarine2-commons/apidocs/it/tidalwave/util/As.Defaults.html?is-external=true" title="class or interface in it.tidalwave.util" class="externalLink">As.Defaults</a>, <a href="http://blueMarine.tidalwave.it/bluemarine2-modules/it-tidalwave-bluemarine2-commons/apidocs/it/tidalwave/util/As.NotFoundBehaviour.html?is-external=true" title="class or interface in it.tidalwave.util" class="externalLink">As.NotFoundBehaviour</a><<a href="http://blueMarine.tidalwave.it/bluemarine2-modules/it-tidalwave-bluemarine2-commons/apidocs/it/tidalwave/util/As.NotFoundBehaviour.html?is-external=true" title="class or interface in it.tidalwave.util" class="externalLink">T</a> extends java.lang.Object></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.it.tidalwave.bluemarine2.model.MediaItem">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface it.tidalwave.bluemarine2.model.<a href="../MediaItem.html" title="interface in it.tidalwave.bluemarine2.model">MediaItem</a></h3>
<code><a href="../MediaItem.Metadata.html" title="interface in it.tidalwave.bluemarine2.model">MediaItem.Metadata</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- =========== FIELD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.it.tidalwave.bluemarine2.model.role.AudioFileSupplier">
<!-- -->
</a>
<h3>Fields inherited from interface it.tidalwave.bluemarine2.model.role.<a href="../role/AudioFileSupplier.html" title="interface in it.tidalwave.bluemarine2.model.role">AudioFileSupplier</a></h3>
<code><a href="../role/AudioFileSupplier.html#_AudioFileSupplier_">_AudioFileSupplier_</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.it.tidalwave.role.Identifiable">
<!-- -->
</a>
<h3>Fields inherited from interface it.tidalwave.role.Identifiable</h3>
<code>_Identifiable_</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.it.tidalwave.bluemarine2.model.spi.PathAwareEntity">
<!-- -->
</a>
<h3>Fields inherited from interface it.tidalwave.bluemarine2.model.spi.<a href="../spi/PathAwareEntity.html" title="interface in it.tidalwave.bluemarine2.model.spi">PathAwareEntity</a></h3>
<code><a href="../spi/PathAwareEntity.html#_PathAwareEntity_">_PathAwareEntity_</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../finder/audio/MusicArtistFinder.html" title="interface in it.tidalwave.bluemarine2.model.finder.audio">MusicArtistFinder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#findComposers()">findComposers</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the composers of the musical expression related to this audio file.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../finder/audio/MusicArtistFinder.html" title="interface in it.tidalwave.bluemarine2.model.finder.audio">MusicArtistFinder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#findMakers()">findMakers</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the makers of this audio file.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.Optional<org.springframework.core.io.Resource></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getContent()">getContent</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the a <code>Resource</code> representing this file's contents, if available.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.util.Optional<<a href="Record.html" title="interface in it.tidalwave.bluemarine2.model.audio">Record</a>></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRecord()">getRecord</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the record related to this audio file.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSize()">getSize</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the size of this file.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.it.tidalwave.util.As">
<!-- -->
</a>
<h3>Methods inherited from interface it.tidalwave.util.<a href="http://blueMarine.tidalwave.it/bluemarine2-modules/it-tidalwave-bluemarine2-commons/apidocs/it/tidalwave/util/As.html?is-external=true" title="class or interface in it.tidalwave.util" class="externalLink">As</a></h3>
<code><a href="http://blueMarine.tidalwave.it/bluemarine2-modules/it-tidalwave-bluemarine2-commons/apidocs/it/tidalwave/util/As.html?is-external=true#as(java.lang.Class)" title="class or interface in it.tidalwave.util" class="externalLink">as</a>, <a href="http://blueMarine.tidalwave.it/bluemarine2-modules/it-tidalwave-bluemarine2-commons/apidocs/it/tidalwave/util/As.html?is-external=true#as(java.lang.Class,it.tidalwave.util.As.NotFoundBehaviour)" title="class or interface in it.tidalwave.util" class="externalLink">as</a>, <a href="http://blueMarine.tidalwave.it/bluemarine2-modules/it-tidalwave-bluemarine2-commons/apidocs/it/tidalwave/util/As.html?is-external=true#asMany(java.lang.Class)" title="class or interface in it.tidalwave.util" class="externalLink">asMany</a>, <a href="http://blueMarine.tidalwave.it/bluemarine2-modules/it-tidalwave-bluemarine2-commons/apidocs/it/tidalwave/util/As.html?is-external=true#asOptional(java.lang.Class)" title="class or interface in it.tidalwave.util" class="externalLink">asOptional</a>, <a href="http://blueMarine.tidalwave.it/bluemarine2-modules/it-tidalwave-bluemarine2-commons/apidocs/it/tidalwave/util/As.html?is-external=true#maybeAs(java.lang.Class)" title="class or interface in it.tidalwave.util" class="externalLink">maybeAs</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.it.tidalwave.bluemarine2.model.role.AudioFileSupplier">
<!-- -->
</a>
<h3>Methods inherited from interface it.tidalwave.bluemarine2.model.role.<a href="../role/AudioFileSupplier.html" title="interface in it.tidalwave.bluemarine2.model.role">AudioFileSupplier</a></h3>
<code><a href="../role/AudioFileSupplier.html#getAudioFile()">getAudioFile</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.it.tidalwave.bluemarine2.util.Dumpable">
<!-- -->
</a>
<h3>Methods inherited from interface it.tidalwave.bluemarine2.util.<a href="http://blueMarine.tidalwave.it/bluemarine2-modules/it-tidalwave-bluemarine2-commons/apidocs/it/tidalwave/bluemarine2/util/Dumpable.html?is-external=true" title="class or interface in it.tidalwave.bluemarine2.util" class="externalLink">Dumpable</a></h3>
<code><a href="http://blueMarine.tidalwave.it/bluemarine2-modules/it-tidalwave-bluemarine2-commons/apidocs/it/tidalwave/bluemarine2/util/Dumpable.html?is-external=true#toDumpString()" title="class or interface in it.tidalwave.bluemarine2.util" class="externalLink">toDumpString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.it.tidalwave.role.Identifiable">
<!-- -->
</a>
<h3>Methods inherited from interface it.tidalwave.role.Identifiable</h3>
<code>getId</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.it.tidalwave.bluemarine2.model.MediaItem">
<!-- -->
</a>
<h3>Methods inherited from interface it.tidalwave.bluemarine2.model.<a href="../MediaItem.html" title="interface in it.tidalwave.bluemarine2.model">MediaItem</a></h3>
<code><a href="../MediaItem.html#getMetadata()">getMetadata</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.it.tidalwave.bluemarine2.model.spi.PathAwareEntity">
<!-- -->
</a>
<h3>Methods inherited from interface it.tidalwave.bluemarine2.model.spi.<a href="../spi/PathAwareEntity.html" title="interface in it.tidalwave.bluemarine2.model.spi">PathAwareEntity</a></h3>
<code><a href="../spi/PathAwareEntity.html#getParent()">getParent</a>, <a href="../spi/PathAwareEntity.html#getPath()">getPath</a>, <a href="../spi/PathAwareEntity.html#getRelativePath()">getRelativePath</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="findMakers()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findMakers</h4>
<pre class="methodSignature">@Nonnull
<a href="../finder/audio/MusicArtistFinder.html" title="interface in it.tidalwave.bluemarine2.model.finder.audio">MusicArtistFinder</a> findMakers()</pre>
<div class="block">Returns the makers of this audio file.
FIXME: shouldn't be here - should be in getTrack().findMakers().</div>
| shouldn't be here - should be in getTrack().findMakers(). | |
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the makers</dd>
</dl>
</li>
</ul>
<a id="findComposers()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findComposers</h4>
<pre class="methodSignature">@Nonnull
<a href="../finder/audio/MusicArtistFinder.html" title="interface in it.tidalwave.bluemarine2.model.finder.audio">MusicArtistFinder</a> findComposers()</pre>
<div class="block">Returns the composers of the musical expression related to this audio file.
FIXME: shouldn't be here - should be in getSignal().findMakers() or such</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the composer</dd>
</dl>
</li>
</ul>
<a id="getRecord()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRecord</h4>
<pre class="methodSignature">@Nonnull
java.util.Optional<<a href="Record.html" title="interface in it.tidalwave.bluemarine2.model.audio">Record</a>> getRecord()</pre>
<div class="block">Returns the record related to this audio file.
FIXME: shouldn't be here - should be in getTrack().getRecord() or such</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the composer</dd>
</dl>
</li>
</ul>
<a id="getSize()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSize</h4>
<pre class="methodSignature">@Nonnegative
long getSize()
throws java.io.IOException</pre>
<div class="block">Returns the size of this file.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the size</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if there was an I/O problem</dd>
</dl>
</li>
</ul>
<a id="getContent()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getContent</h4>
<pre class="methodSignature">@Nonnull
java.util.Optional<org.springframework.core.io.Resource> getContent()
throws java.io.IOException</pre>
<div class="block">Returns the a <code>Resource</code> representing this file's contents, if available.
FIXME: not good to use Spring Resource...</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the contents</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if there was an I/O problem</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/AudioFile.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li><a href="#nested.class.summary">Nested</a> | </li>
<li><a href="#field.summary">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright © 2015–2023 <a href="http://tidalwave.it">Tidalwave s.a.s.</a>. All rights reserved.</small></p>
</footer>
</body>
</html>