Guidance
Apply for a Tier 4 sponsor licence
How to apply for a student sponsor licence.
Apply for a Tier 4 sponsor licence if you want to enrol students from outside the European Economic Area (EEA).
A Tier 4 sponsor is an education provider that offers courses of study to full-time students in the UK. There are some exceptions, read the sponsor guidance to find out if your institution is eligible.
How to apply for a Tier 4 licence
Check the education provider or institution meets the sponsor requirements in the sponsor guidance and is ready to comply with them.
- Decide who will do the sponsor management roles within your institution.
- Estimate the number of confirmations of acceptance for studies (CAS) you would like to apply for in the first year of your licence.
- Apply online and pay the fee.
- Send UK Visas and Immigration (UKVI) the documents listed in sponsor guidance appendix A.
- If your application is approved, you’ll be given probationary sponsor status and emailed a login for the sponsorship management system.
When you successfully apply for a Tier 4 licence, UKVI will give you a probationary sponsor licence. This is a transitional period lasting 12 months whilst you demonstrate you can fulfil all of your duties as a Tier 4 sponsor. You must apply for a basic compliance assessment after 12 months.
Apply for your licence
You apply for your licence online. It should take about 20 minutes.
You’ll need to pay a fee when you apply online. The licence application fee is £536.
Print off the submission sheet and send it with your supporting documents to UKVI.
Sponsor casework operations
Sponsor applications team
UK Visas and Immigration
PO Box 3468
Sheffield
S3 8WA
UKVI will review your application. They may want to visit your institution.
Most applications are dealt with in 4 weeks.
When UKVI have made a decision, they will write to tell you if you’ve been successful.
Contact
If you have a question about your application, contact:
Education providers’ helpline<EMAIL_ADDRESS>Telephone: 0300 123 4699
Sponsorship management roles
When you apply for your licence you’ll need to allocate these 4 roles to members of your staff:
- authorising officer – a senior and competent person who is responsible for the actions of staff and representatives who use the sponsor management system (SMS)
- key contact – your main point of contact with UKVI about your institution’s application
- level 1 user – responsible for all day-to-day management of your licence using the SMS
- level 2 user – an SMS user with more restricted permissions than a level 1 user
These roles can all be filled by the same person or by a combination of different people.
Check staff are suitable
You and your staff must pass UKVI checks to fill these positions. You may not get your licence or you may lose it if any of these people have:
- an unspent criminal conviction
- a fine issued by UKVI in the past 12 months
- been reported to UKVI or broken the law
They must also:
- be based permanently in the UK
- not be a contractor or consultant contracted for a specific project
- not be subject to a bankruptcy restriction order or undertaking, or a debt relief restriction order or undertaking
In most cases they must also be a paid member of your staff or someone who has an unpaid but official role, eg a statutory appointment, an appointment by internal constitution or trust deed.
You can read the full guidance on appointing ‘Allocate key personnel’ section in the sponsor guidance.
Estimate how many Confirmation of Acceptance for Studies you need
A CAS is a virtual document, similar to a database record. You complete a process that produces a unique CAS reference number, which you give to the student. A CAS is your way of confirming, as a licensed sponsor, that:
- you want to sponsor an overseas student to study in the UK
- to the best of your knowledge, that student meets the requirements of the rules for a valid CAS and will be able to make a successful application for leave to come to or stay in the UK
When you apply for a sponsor licence, you must apply for the number of confirmations of acceptance for studies (CAS) you would like to assign in your first year.
The number must include:
- existing students who you expect to apply for an extension
- new students you want to sponsor
You may request a CAS allocation of up to 50 per cent of your current student body. Your student body must comprise UK, EU or Swiss nationals.
You must provide evidence to support your request, as well as your educational oversight report. As set out in our sponsor guidance, UKVI will consider a range of factors in order to reach a decision on your CAS allocation.
Be prepared to meet your sponsorship duties
Before you apply you must have certain things in place.
When you apply for a sponsor licence, you must show that you meet the eligibility and suitability requirements as an education provider.
You must show that all of your sites meet acceptable education standards. You must:
- have had a Tier 4 educational oversight inspection or a statutory education inspection , and you must have achieved the required rating; or
- be recognised as an overseas HEI offering short-term ‘study abroad’ programmes in your own premises in the UK.
You can find out more information in the ‘Educational Oversight requirement’ section in document 1 of the Tier 4 sponsor guidance.
As a Tier 4 sponsor, you must comply with the guidance for sponsors and fulfil certain duties. For example, you must contact UKVI if a student:
- does not arrive for their course;
- is absent without permission for a significant period;
- leaves their course earlier than expected; or
- is asked to leave the course.
You must keep proper records of the students you sponsor, including contact details and a copy of their passport and Biometric Residence Permit (BRP) and give them to UKVI when it asks for them. For more information see sponsor guidance Appendix D.
UKVI will monitor your compliance with your duties. It will:
- give you a suitable allocation of CAS, dependent on the size of your current student body;
- make visits, pre-arranged or not, to check compliance; and
- issue civil penalties if it finds evidence that you have breached the illegal working regulations
Where there has been a breach of sponsor duties, UKVI will consider the nature of the breach and may take compliance action against you.
Tier 4 sponsor status
When you have had a probationary sponsor licence for 12 months, you must apply for a basic compliance assessment in order to gain Tier 4 Sponsor status. UKVI will revoke your licence if you do not meet the requirements.
The sponsor guidance explains how to apply for a basic compliance assessment.
Tier 4 premium customer service
The Tier 4 premium customer service is designed to:
- offer your organisation support in sponsoring all overseas students
- develop a relationship with you and a long-term understanding of your requirements
The Tier 4 premium customer service for sponsors contains more information on this service.


Nigeria redeploys several senior police officers - Premium Times Nigeria
by Agency ReportThe Inspector-General of Police (IGP), Mohammed Adamu, has ordered the redeployment of the recently promoted Commissioners of Police to the rank of Assistant Inspectors General (AIG).
The Force Public Relations Officer (FPRO), Frank Mba, disclosed this in a statement on Saturday in Abuja.
“The newly deployed senior officers to zones and formations are Dan Bature, AIG DFA FHQ, Hyelasinda Musa, AIG PMF, Yunana Babas, AIG Zone 8 Lokoja and Dan Mohammed, AIG SPU
“Mua’zu Halilu, AIG CTU, Rabiu Yusuf, AIG ICT, Ahmed Iliyasu, AIG Zone 2, Lagos, AIG Mohammed Kura, AIG Maritime, Zaki Ahmed, AIG Zone 6, Calabar and Zama Senchi, AIG Community Policing.
“Others are Bello Sadiq – AIG Zone 1, Kano, Austin Iwero, AIG DOPS FHQ and Lawal Ado, AIG Works,” he said.
Mr Mba said the IGP had called on the newly redeployed officers to bring their vast experiences and professionalism to bear in advancing the fortunes of the force.
He said Mr Adamu further directed the AIGs to ensure adequate supervision of their respective departments and formations to enhance the ongoing drive at repositioning the force for improved service delivery.
Mr Mba said the posting and the redeployment of the officers were with immediate effect. (NAN)


Angular File Input
Input text data using a bootstrap style button for file input
Lightweight
No dependency on jQuery
Simple Example
Fileupload
File Text
{{ fileText }}


Problem 1. Numbers
Write a script that prints all the numbers from 1 to N.
Write a script that prints all the numbers from 1 to N.
Write a script that prints all the numbers from 1 to N, that are not divisible by 3 and 7 at the same time
Write a script that finds the max and min number from a sequence of numbers.
Write a script that finds the lexicographically smallest and largest property in document, window and navigator objects.


"Un-push" Batch From Production
Sometimes a batch is messed up enough that it needs to be completely removed, rebuilt, and reingested, but it’s already in production. In the (rare) cases this happens and we haven’t already archived all the original files, we can un-push the batch and requeue the necessary issues.
This procedure helps “un-push” batches, but only when all of the following are true:
- The batch was created by NCA, not a vendor. There’s currently no procedure for reading a non-NCA batch and putting its issues in the database.
- The batch is live, but hasn’t been fully archived yet
- In theory you could still do this after archival, but the work gets a lot more involved and isn’t in scope here.
- All issues are still in NCA’s database and their files are still in the NCA “workflow” location on disk (this is usually true until archival).
This process is awful and you need to know what you’re doing, but here’s the rough outline:
- If at all possible, turn off NCA’s services (workers and http). If you can’t do this, things could get messy if you have a problem and have to rollback database or filesystem changes.
- Back up your database! The filesystem may be too much to back up, so it can be a pain if you need to fix something, but it’s still really helpful to at least have a “good DB state”.
- Move your batch to the the “ready for ingest” location (e.g.,
/mnt/news/outoging
) from wherever it goes to be archived - In the database, set the batch’s
location
to the full path to the batch you just copied- e.g.,
/mnt/news/outgoing/batch_foo_20180918BasaltVampireTramplingCrabgrass_ver01
- e.g.,
- “Un-ignore” the issues, clear their batch id, and set their state
“ReadyForRebatching” rather than the typical “ReadyForBatching”. This is
important to avoid accidentally putting these into new batches before you’ve
fixed things.
- e.g.,
UPDATE issues SET batch_id = 0, ignored = 0, workflow_step = 'ReadyForRebatching' WHERE batch_id = ?
- This isn’t scary because you made a database backup. Right?
- e.g.,
- Mark the batch ‘deleted’:
UPDATE batches SET location = '' AND status = 'deleted' WHERE id = ?
- Still not scary.
- Do whatever fixes you need to (in our case, altering the
marc_org_code
for a bunch of issues) - Create a new fixed-issue batch (or batches):
/path/to/nca/bin/queue-batches -c /path/to/nca/settings --redo
- This will rebatch all issues at the
ReadyForRebatching
workflow step. If you only process one problem batch at a time, though, this shouldn’t do anything but rebuild whatever was busted (meaning you may not need to re-QC it, or if you do, it’s at least an isolated set of issues).
- Purge the original batch from staging and production.
- This seems scary, but at this point you still have the live batch, the archival files, and a database backup.
- Make the new batch(es) live on staging and production.
- See technical workflow docs for information about batch management.
- Delete the batch from your live location.
- This seems scary, but when you mark batches as being ready for production,
NCA is copying a subset of them to the “ready for ingest” location. The
originals are kept for a while even after a batch is flagged for archival
- Again, see our technical workflow docs for details.
- This seems scary, but when you mark batches as being ready for production,
NCA is copying a subset of them to the “ready for ingest” location. The
originals are kept for a while even after a batch is flagged for archival
- Delete your archived batch. This is the original batch you moved from the
archive location early in this process.
- This is kind of scary, but you should now have a new batch (or multiple batches) containing all the issues which were in the original batch. The files are all the same, the database still has metadata, and the old archive’s only difference is whatever mistake you were rectifying.


Anonymous Online Counseling
First Steps
Start Bootstrap
Home
(current)
Client
Counselors
Resources
Counselor Information
Counselor: Enter your information into the following fields to be matched with a person in need of counseling
Area of Expertise:
Age Group Specialty:
Children (0-12)
Adolescent (13-17)
Adult (18+)
No Specification
Gender Specialty:
Male
Female
Trans Male/Female
No Specification
Sexuality Specialty:
Heterosexual
Homosexual
Bisexual
No Specification


| Package | Description |
|---|---|
| org.ejvm.execution |
Contains classes used to execute compiled eJVM bytecode.
|
| Class and Description |
|---|
| EjvmExecutionException.Reason
This enum contains all reasons why an
EjvmExecutionException may have been thrown. |
| EjvmExecutionListener
Provides an interface for listeners informed about the steps of the execution of an
EjvmProgram . |
| EjvmInstruction
Contains all instructions executable by the
EjvmProcessor . |
| EjvmInstruction.ArgumentType
Describes the types arguments to an eJVM instruction may have.
|
| EjvmMachine
Represents a machine capable of executing eJVM bytecode and acts as the machine's operating system.
|
| EjvmProcess
Represents a process in an
EjvmMachine to execute an EjvmProgram and manages the associated
resources. |
| EjvmProcess.OutputFormatter
Simple enum to represent the output mode set for a process.
|
| EjvmProcess.ProcessState
Simple enum to represent the process state.
|
| EjvmProcessor
Represents a processor capable of executing eJVM bytecode instructions.
|
| EjvmProcessor.ProcessorState
Represents the state of the processor.
|


Why 99% Of All Crypto Assets Are Not Investment Worthy
by Martin YoungThere are many factors when determining what makes a good investment in the crypto market. Liquidity is one, whether day trading or looking for longer term gains. Recent findings however reveal that only a very few cryptocurrencies have any measurable liquidity.
Only 40 Crypto Assets Have Significant Volume
Back in 2017 when the crypto bubble was inflating like the early universe, investors were advised to look at the whitepaper, the team, the project, and the technology before parting with any cash. Today it is a very different scene, as nearly all of the altcoins have collapsed in price regardless of the team or technology.
This massive contraction, which was largely caused by a regulatory crackdown on ICOs and the bursting of an immature speculatory bubble, has left very few survivors. A different set of criteria has emerged in 2019 for what makes something investment worth, and liquidity plays a big part.
For an asset to be tradable it needs to have daily volume. One that does nothing means that nobody is interested in buying or selling it. Coinmarketcap lists almost 4,800 cryptocurrencies though 99% are completely illiquid.
Crypto industry analyst Willy Woo has pulled some charts showing which ones have the most volume and which altcoins are pretty much dead.
“Coinmarketcap lists 4978 coins. Here’s the top 50 by volume. Below the top 40 doesn’t even register i.e. 4938 coins are illiquid.”
That figure effectively equates to 99% of all the cryptos listed on CMC. Many of them are dead coins with no recent development updates or ongoing work on their respective projects. Some, however, are still soldiering on with updates and blockchain development yet nobody wants to trade them.
The lack of an altseason could be the primary reason. But there are several altcoins that were once top ten contenders in terms of market capitalization, and have now fallen down the chart into digital obscurity.
There is the premise that very few of these projects even existed three years ago as pointed out by Shapeshift CEO Erik Voorhees. Back then CMC only listed 652 crypto assets so the number has grown by 660% in just three years. Additionally six of the top ten in November 2016 have been dumped down the chart today.
The Liquidity Kings
Back to the liquidity, Tether is the obvious top in terms of volume as it is the current stablecoin standard. Naturally bitcoin and Ethereum make up the next two, with Litecoin in fourth. LTC gets a lot of FUD but it has been a crypto stalwart for the past eight years while many have come and gone.
The rest of the top ten in terms of volume include EOS, BCH, XRP, Tron, NEO and ETC. The thirty below them have minor liquidity but the question remains; are any of the thousands of non-traded altcoins still worth investing in?
Will altcoin volumes surge again? Add your comments below.
Images via Shutterstock, Twitter @woonomic
The Rundown


THE ASH-TREE
WEAKLY children--"children that wouldn't goode," or thrive - were sometimes drawn through the cleft ash-tree. I have seen the ceremony performed but in one case.
The tree was young, and it was taken by the two forks,-- bifurcation having taken place,--and by force rended longitudinally. The cleft was kept open, and the child, quite naked, was passed head first through the tree nine times. The tree was then closed and carefully tied together. If the severed parts reunited, the child and the tree recovered together; if the cleft gaped in any part, the operation was certain to prove ineffectual.
I quote another example. A large knife was inserted into the trunk of the young tree, about a foot from the ground, and a vertical rending made for about three feet. Two men then forcibly pulled the parts asunder, and held them so, whilst the mother passed the child through it three times. This "passing" alone was not considered effective; it was necessary that the child should be washed for three successive mornings in the dew from the leaves of the "charmed ash."
In the Athenaem for September 1846, Ambrose Merton - Mr Thom--has some interesting notices of the wide-spread belief in, and the antiquity of, this superstition.


Code CBT Developer Contribution
Feel free to make this software unique with your own ideas and toughts. Make your ideas count on Github
Contributing
You can contribute to the project by cloning or downloading the repository and then making pull requests (PRs). You can also create github issues if you have a suggestion or a problem. You are not expected to push your changes directly t othe master branch but to create a seperate branch and then push this branch. This is to be done so that the master branch can be kept clean and free from errors.
Adding a new question
You can make a pull request with a commit message stating the file you editted and the question id added on to from the last id in the right structure. For example if the last id in the js.json file was js43 and you are to add a question, the new question's id should be js44.


You may want to import a single static reference file - such as loading a daily symbol list, or an AI-training file. This is possible with the $[Download(),M:QuantConnect.Algorithm.QCAlgorithm.Download] method. The Download
method downloads a URL and returns it as a string. It can take header settings for authentication, and a username and password for basic authentication.
// If using dropbox remember to add the &dl=1 to trigger a download var file = Download("https://www.dropbox.com?....&dl=1");
# If using dropbox remember to add the &dl=1 to trigger a download csv = self.Download("https://www.dropbox.com?....&dl=1") # read file (which needs to be a csv) to a pandas DataFrame. include following imports above # from io import StringIO # import pandas as pd df = pd.read_csv(StringIO(csv))
It is a common request to download data from a public Dropbox file. In this case, you should ensure you're downloading the direct file link - not the HTML page of the download. You can specify this by adding &dl=1
to the end of the Dropbox download URL.


Dark
This can toggle light/dark in all browsers except IE11/EdgeHTML14.
This can also be applied to the HTML element directly.
Toggle
Dark
This can toggle light/dark in all browsers.
Toggle


The Indexical Imagination: Documentary Aesthetics and the Literary History of Information Culture
My digital senior honors thesis examines literary information devices––indexes, tables of contents, footnotes, appendixes, etc––and their role in the social and literary production of knowledge.
The Early Novels Database
I designed the web interface for a bibliographic database of slow metadata on eighteenth century novels designed to re-imagine the role of the bibliographic database as a site for creative exploration and information dissemation.
Researching Benjamin Researching: The Arcades Project Through the Eyes of a Digital Flâneur
Using the form of a digital "assemblage" I created a web-essay that highlights the relationship between the form and content of the research practices of German philosopher Walter Benjamin in his massive, unfinished experiment in hisotoriography, The Arcades Project.


--- layout: post status: publish published: true title: Active Directory Authentication for Ruby on Rails author: display_name: Geoff Lane login: admin email<EMAIL_ADDRESS>url: http://www.zorched.net author_login: admin author_email<EMAIL_ADDRESS>author_url: http://www.zorched.net date: '2007-06-04 19:44:15 -0400' date_gmt: '2007-06-05 01:44:15 -0400' categories: - Ruby tags: - ruby-on-rails - active-directory ---
Ruby on Rails can be used to build many kinds of web applications including public internet applications as well as private intranet ones. As an intranet application it is often very interesting to be able to do Single Sign-On using an existing Active Directory setup. Rails does not support NTLM authentication out of the box which is what is required.
If you want to try this route, check out RoR IIS which has a lot of instructions as well as an installer that can do a lot for you. (Again, I tried this first and it didn't work, so your mileage my vary.)
Running Rails under Apache can be a bit tricky. There are a lot of options to choose from: mod_ruby, fast_cgi, proxying and scgi. All of these options with no real breakdown that I could find of why use one over another? Proxying with multiple mongrel instances is a very common combination, but I did not want to have mongrel running because I don't want a way to end-run around the authentication mechanism. So, I again tried FastCGI, this time under Apache. Me and FastCGI don't seem to get along though and it again failed to work.
InstantRails uses SCGI though and as a reference implementation for Rails and Apache on Windows, I figured that was a promising path.. SCGI is supposed to be a simpler form of CGI with all of the performance advantages of FastCGI. SCGI is a two part solution. There is an Apache module and there is an SCGI server that runs the rails application. Using this combination, I was able to get Rails running under Apache on Windows.
Under Apache the setup is fairly simple: {% highlight httpd %} LoadModule scgi_module modules/mod_scgi.so SCGIMount / <IP_ADDRESS>:9999 {% endhighlight %}
Rails SCGI is well documented information including configuring Apache. So, I won't repeat everything.
{% highlight httpd %} LoadModule sspi_auth_module modules/mod_auth_sspi.so
The most common way to check that a user is authenticated in Rails is to use a before_filter in your controllers to check that the session is properly setup and to send the user to a Login controller if they are not authenticated. You'll need do the same thing in this case: {% highlight ruby %} class ApplicationController < ActionController::Base protected def authenticate unless session[:user] redirect_to :controller => "login" return false else # TODO: Check that the current user is the same as the session user # TODO: Check user against active directory every time? # request.env["REMOTE_USER"] end end end {% endhighlight %}
Most LoginContollers will show the user a form that allows them to authenticate. A User object is then used to authenticate that the username and password are correct. This implementation will be slightly different though. When Authentication is done by Apache it will set an HTTP variable request.env["REMOTE_USER"] that will be available in your Controllers to identify who the authenticated User is. You can use this information to learn about the user instead of showing them a login form. Remember, the user has already been authenticated by the Active Directory domain, so the user's credentials have been checked.
{% highlight ruby %} class LoginController < ApplicationController def index success = false user = User.find_by_name(request.env["REMOTE_USER"]); if user session[:user] = user success = true end
redirect_to request.env["HTTP_REFERER"] ? :back : '/' if success redirect_to :action => :error if ! success end def logout session[:user] = nil end def error end end {% endhighlight %}In the login controller you can get the REMOTE_USER information and then do whatever you need to do with that information. Most likely you'll want to call into Active Directory using something like ruby-ldap to check on things like groups or role membership and to get extra User information.
Hopefully this information will help someone else out because it definitely is not an obvious thing to do (at least it wasn't to me).


Overview
Package
Class
Tree
Index
Help
PREV NEXT
FRAMES
NO FRAMES
All Classes
A
B
C
D
E
F
G
H
I
L
N
P
R
S
T
U
V
W
Y
A
add(String, String)
- Method in class com.echonest.api.v4.
Params
Adds a parameter and value to the parameter set
add(String, int)
- Method in class com.echonest.api.v4.
Params
add(String, List<String>)
- Method in class com.echonest.api.v4.
Params
add(String, String[])
- Method in class com.echonest.api.v4.
Params
add(String, float)
- Method in class com.echonest.api.v4.
Params
add(String, boolean)
- Method in class com.echonest.api.v4.
Params
addArtist(String)
- Method in class com.echonest.api.v4.
PlaylistParams
Adds the name of a seed artist
addArtistID(String)
- Method in class com.echonest.api.v4.
PlaylistParams
Adds an ID of a seed artist
addDescription(String)
- Method in class com.echonest.api.v4.
ArtistParams
Adds a description
addDescription(String)
- Method in class com.echonest.api.v4.
PlaylistParams
Adds a description of the type of artists that can be included in the playlist
addDescription(String)
- Method in class com.echonest.api.v4.
SongParams
addID(String)
- Method in class com.echonest.api.v4.
ArtistParams
Sets the artist ID
addIDSpace(String)
- Method in class com.echonest.api.v4.
ArtistParams
addIDSpace(String)
- Method in class com.echonest.api.v4.
PlaylistParams
addIDSpace(String)
- Method in class com.echonest.api.v4.
SongParams
addMood(String)
- Method in class com.echonest.api.v4.
PlaylistParams
Adds a mood of the type of artists that can be included in the playlist
addName(String)
- Method in class com.echonest.api.v4.
ArtistParams
addSeedCatalog(String)
- Method in class com.echonest.api.v4.
PlaylistParams
Adds a seed catalog
addStyle(String)
- Method in class com.echonest.api.v4.
PlaylistParams
Adds a style of the type of artists that can be included in the playlist
Artist
- Class in
com.echonest.api.v4
Represents and Echo Nest Artist
ArtistCatalog
- Class in
com.echonest.api.v4
ArtistCatalogItem
- Class in
com.echonest.api.v4
Represent items for an artist catalog
ArtistCatalogItem(String)
- Constructor for class com.echonest.api.v4.
ArtistCatalogItem
Creates a catalog item with the given item ID
ArtistParams
- Class in
com.echonest.api.v4
Manages params for artist search and similarity requests
ArtistParams()
- Constructor for class com.echonest.api.v4.
ArtistParams
Audio
- Class in
com.echonest.api.v4
B
ban(String)
- Method in class com.echonest.api.v4.
CatalogUpdater
Indicate that the given item has been banned
banArtist()
- Method in class com.echonest.api.v4.
DynamicPlaylistParams
Bands the current artist
banSong()
- Method in class com.echonest.api.v4.
DynamicPlaylistParams
Bans the current song
banTerm(String)
- Method in class com.echonest.api.v4.
DynamicPlaylistParams
Bans the given term from appearing on the session
Biography
- Class in
com.echonest.api.v4
Blog
- Class in
com.echonest.api.v4
C
CatalogItem
- Class in
com.echonest.api.v4
Represents a catalog item
CatalogItem(String)
- Constructor for class com.echonest.api.v4.
CatalogItem
CatalogUpdater
- Class in
com.echonest.api.v4
CatalogUpdater()
- Constructor for class com.echonest.api.v4.
CatalogUpdater
CLIENT_SERVER_INCONSISTENCY
- Static variable in exception com.echonest.api.v4.
EchoNestException
the client API expected something different from the server
com.echonest.api.v4
- package com.echonest.api.v4
createArtistCatalog(String)
- Method in class com.echonest.api.v4.
EchoNestAPI
Creates an artist catalog
createDynamicPlaylist(Params)
- Method in class com.echonest.api.v4.
EchoNestAPI
Creates a dynamic playlist.
createSongCatalog(String)
- Method in class com.echonest.api.v4.
EchoNestAPI
Creates a song catalog
createStaticPlaylist(Params)
- Method in class com.echonest.api.v4.
EchoNestAPI
create a static playlist
D
delete(String)
- Method in class com.echonest.api.v4.
CatalogUpdater
Deletes the item from the catalog
dump()
- Method in class com.echonest.api.v4.
TrackAnalysis
dump(boolean)
- Method in class com.echonest.api.v4.
WebDocument
dump()
- Method in class com.echonest.api.v4.
WebDocument
dump()
- Method in class com.echonest.api.v4.
YearsActive
DynamicPlaylistParams
- Class in
com.echonest.api.v4
DynamicPlaylistParams()
- Constructor for class com.echonest.api.v4.
DynamicPlaylistParams
E
EchoNestAPI
- Class in
com.echonest.api.v4
The main interface to the Echo Nest API
EchoNestAPI()
- Constructor for class com.echonest.api.v4.
EchoNestAPI
Creates a new EchoNestAPI.
EchoNestAPI(String)
- Constructor for class com.echonest.api.v4.
EchoNestAPI
Creates a new EchoNestAPI with the given API key
EchoNestException
- Exception in
com.echonest.api.v4
Represents echo nest oriented exceptions
EchoNestException(int, String)
- Constructor for exception com.echonest.api.v4.
EchoNestException
Creates an exception
EchoNestException(Throwable)
- Constructor for exception com.echonest.api.v4.
EchoNestException
Creates an exception
ENItem
- Class in
com.echonest.api.v4
equals(Object)
- Method in class com.echonest.api.v4.
ENItem
ERR_ACCESS_DENIED
- Static variable in exception com.echonest.api.v4.
EchoNestException
API Key is not allowed to call this method
ERR_INVALID_PARAMETER
- Static variable in exception com.echonest.api.v4.
EchoNestException
access to an invalid field
ERR_MISSING_OR_INVALID_API_KEY
- Static variable in exception com.echonest.api.v4.
EchoNestException
Missing/Invalid API Key
ERR_MISSING_PARAMETER
- Static variable in exception com.echonest.api.v4.
EchoNestException
missing parameter
ERR_NO_KEY
- Static variable in exception com.echonest.api.v4.
EchoNestException
no api key was given
ERR_RATE_LIMIT_EXCEEDED
- Static variable in exception com.echonest.api.v4.
EchoNestException
Rate limit exceeded
F
favorite(String)
- Method in class com.echonest.api.v4.
CatalogUpdater
Indicate that the given item is a favorite
fetchBucket(String)
- Method in class com.echonest.api.v4.
ENItem
fetchBucket(String, boolean)
- Method in class com.echonest.api.v4.
ENItem
fetchBuckets(String[])
- Method in class com.echonest.api.v4.
ENItem
fetchBuckets(String[], boolean)
- Method in class com.echonest.api.v4.
ENItem
G
getAnalysis()
- Method in class com.echonest.api.v4.
Song
getAnalysis()
- Method in class com.echonest.api.v4.
Track
getAnalysisURL()
- Method in class com.echonest.api.v4.
Song
getAnalysisURL()
- Method in class com.echonest.api.v4.
Track
Gets the analysis url for the track
getArtistCatalogByID(String)
- Method in class com.echonest.api.v4.
EchoNestAPI
Gets a previously created artist catalog by ID
getArtistCatalogByName(String)
- Method in class com.echonest.api.v4.
EchoNestAPI
Gets a previously created artist catalog by name
getArtistFamiliarity()
- Method in class com.echonest.api.v4.
Song
getArtistHotttnesss()
- Method in class com.echonest.api.v4.
Song
getArtistID()
- Method in class com.echonest.api.v4.
ArtistCatalogItem
Returns the artist id
getArtistID()
- Method in class com.echonest.api.v4.
Song
getArtistLocation()
- Method in class com.echonest.api.v4.
Song
getArtistName()
- Method in class com.echonest.api.v4.
ArtistCatalogItem
returns the artist name
getArtistName()
- Method in class com.echonest.api.v4.
Audio
Gets the artist name
getArtistName()
- Method in class com.echonest.api.v4.
Song
getArtistName()
- Method in class com.echonest.api.v4.
Track
Gets the artist name for the track
getAudio()
- Method in class com.echonest.api.v4.
Artist
Deprecated.
getAudio(int, int)
- Method in class com.echonest.api.v4.
Artist
Deprecated.
getAudio()
- Method in class com.echonest.api.v4.
Song
getAudioMD5()
- Method in class com.echonest.api.v4.
Track
Gets the MD5 of the audio for the track
getAudioUrl()
- Method in class com.echonest.api.v4.
Track
Gets the audio url
getBars()
- Method in class com.echonest.api.v4.
TrackAnalysis
getBeats()
- Method in class com.echonest.api.v4.
TrackAnalysis
getBiographies()
- Method in class com.echonest.api.v4.
Artist
Gets the latest bios for this artist
getBiographies(int, int)
- Method in class com.echonest.api.v4.
Artist
Gets a paged list of bios for this artist
getBiographies(int, int, String)
- Method in class com.echonest.api.v4.
Artist
Gets a paged list of bios for this artist
getBiographies(int, int, List<String>)
- Method in class com.echonest.api.v4.
Artist
Gets a paged list of bios for this artist
getBlogs()
- Method in class com.echonest.api.v4.
Artist
Gets a list of the most recent blogs for this artist
getBlogs(int, int, boolean)
- Method in class com.echonest.api.v4.
Artist
Gets a paged list of recent blogs for this artist
getBlogs(int, int)
- Method in class com.echonest.api.v4.
Artist
Gets a paged list of recent blogs for this artist
getCode()
- Method in exception com.echonest.api.v4.
EchoNestException
Gets the error code
getConfidence()
- Method in class com.echonest.api.v4.
TimedEvent
getCoverArt()
- Method in class com.echonest.api.v4.
Song
getDanceability()
- Method in class com.echonest.api.v4.
Song
getDate()
- Method in class com.echonest.api.v4.
Audio
Gets the date of the audio
getDateFound()
- Method in class com.echonest.api.v4.
Blog
Gets the date found
getDateFound()
- Method in class com.echonest.api.v4.
News
Gets the date found
getDateFound()
- Method in class com.echonest.api.v4.
Review
Get the date the item was found
getDateFound()
- Method in class com.echonest.api.v4.
Video
Gets the date the image was found
getDatePosted()
- Method in class com.echonest.api.v4.
Blog
Gets the date posted
getDatePosted()
- Method in class com.echonest.api.v4.
News
Gets the date posted
getDateReviewed()
- Method in class com.echonest.api.v4.
Review
Get the date the item was reviewed
getDocCounts()
- Method in class com.echonest.api.v4.
Artist
Gets a map of URLs for this artist
getDouble(String)
- Method in class com.echonest.api.v4.
CatalogItem
Gets an float value associated with a name
getDouble(String)
- Method in class com.echonest.api.v4.
ENItem
getDuration()
- Method in class com.echonest.api.v4.
Song
getDuration()
- Method in class com.echonest.api.v4.
TimedEvent
getDuration()
- Method in class com.echonest.api.v4.
Track
Gets the duration for the track
getDuration()
- Method in class com.echonest.api.v4.
TrackAnalysis
getEndOfFadeIn()
- Method in class com.echonest.api.v4.
TrackAnalysis
getEnergy()
- Method in class com.echonest.api.v4.
Song
getFamiliarity()
- Method in class com.echonest.api.v4.
Artist
Gets the familiarity of the artist
getForeignID(String)
- Method in class com.echonest.api.v4.
Artist
Gets a foreign id for this artist
getForeignID()
- Method in class com.echonest.api.v4.
Track
Gets the foreign ID for the track
getFrequency()
- Method in class com.echonest.api.v4.
Term
getHotttnesss()
- Method in class com.echonest.api.v4.
Artist
Gets the hotttnesss for the artist
getID()
- Method in class com.echonest.api.v4.
Artist
Gets the ID for the artist
getID()
- Method in class com.echonest.api.v4.
CatalogItem
Gets the ID of the item
getID()
- Method in class com.echonest.api.v4.
ENItem
getImages()
- Method in class com.echonest.api.v4.
Artist
Gets a list of the most recent images for this artist
getImages(int, int)
- Method in class com.echonest.api.v4.
Artist
Gets a paged list of recent images for this artist
getImages(int, int, List<String>)
- Method in class com.echonest.api.v4.
Artist
Gets a paged list of recent images for the artist
getImages(int, int, String)
- Method in class com.echonest.api.v4.
Artist
Gets a paged list of images for this artist
getImageURL()
- Method in class com.echonest.api.v4.
Review
Gets an image associated with the review
getImageURL()
- Method in class com.echonest.api.v4.
Video
Gets a thumbnail image of the video
getInteger(String)
- Method in class com.echonest.api.v4.
CatalogItem
Gets an int value associated with a name
getInteger(String)
- Method in class com.echonest.api.v4.
ENItem
getItemMap(String)
- Method in class com.echonest.api.v4.
ENItem
getItemMap(String, String)
- Method in class com.echonest.api.v4.
ENItem
getItemMap(String, String, String)
- Method in class com.echonest.api.v4.
ENItem
getItemMap(String, List<String>)
- Method in class com.echonest.api.v4.
ENItem
getItemMapByName(String, String)
- Method in class com.echonest.api.v4.
ENItem
getKey()
- Method in class com.echonest.api.v4.
Song
getKey()
- Method in class com.echonest.api.v4.
Track
Gets the key for the track
getKey()
- Method in class com.echonest.api.v4.
TrackAnalysis
getKeyConfidence()
- Method in class com.echonest.api.v4.
TrackAnalysis
getKnownTrack(String)
- Method in class com.echonest.api.v4.
EchoNestAPI
Determines whether or not the track is known by the echo nest
getKnownTrack(File)
- Method in class com.echonest.api.v4.
EchoNestAPI
Determines whether or not the track is known by the echo nest
getLatitude()
- Method in class com.echonest.api.v4.
Location
getLength()
- Method in class com.echonest.api.v4.
Audio
Gets the length (in seconds) of the audio
getLicenseAttribution()
- Method in class com.echonest.api.v4.
Biography
Gets the attribution for the bio
getLicenseAttribution()
- Method in class com.echonest.api.v4.
Image
Gets the image license attribution
getLicenseType()
- Method in class com.echonest.api.v4.
Biography
Gets the license type for the bio
getLicenseType()
- Method in class com.echonest.api.v4.
Image
Gets the license for the image
getLink()
- Method in class com.echonest.api.v4.
Audio
Gets the audio link
getList(String)
- Method in class com.echonest.api.v4.
CatalogItem
Gets the list associated with the name
getLongitude()
- Method in class com.echonest.api.v4.
Location
getLoudness()
- Method in class com.echonest.api.v4.
Song
getLoudness()
- Method in class com.echonest.api.v4.
Track
Gets the loudness for the track
getLoudness()
- Method in class com.echonest.api.v4.
TrackAnalysis
getLoudnessMax()
- Method in class com.echonest.api.v4.
Segment
getLoudnessMaxTime()
- Method in class com.echonest.api.v4.
Segment
getLoudnessStart()
- Method in class com.echonest.api.v4.
Segment
getMap(String)
- Method in class com.echonest.api.v4.
CatalogItem
Gets the map associated with the name
getMap()
- Method in class com.echonest.api.v4.
Params
getMap()
- Method in class com.echonest.api.v4.
TrackAnalysis
getMD5()
- Method in class com.echonest.api.v4.
TrackAnalysis
getMessage()
- Method in exception com.echonest.api.v4.
EchoNestException
Gets the exception message
getMinCommandTime()
- Method in class com.echonest.api.v4.
EchoNestAPI
Gets the minimum time between commands
getMode()
- Method in class com.echonest.api.v4.
Song
getMode()
- Method in class com.echonest.api.v4.
Track
Gets the mode for the track
getMode()
- Method in class com.echonest.api.v4.
TrackAnalysis
getModeConfidence()
- Method in class com.echonest.api.v4.
TrackAnalysis
getName()
- Method in class com.echonest.api.v4.
Artist
Gets the name of the artist
getName()
- Method in class com.echonest.api.v4.
Blog
Gets the blog name
getName()
- Method in class com.echonest.api.v4.
News
Gets the news article title
getName()
- Method in class com.echonest.api.v4.
Review
Gets the title of the review
getName()
- Method in class com.echonest.api.v4.
Term
getNews()
- Method in class com.echonest.api.v4.
Artist
Gets the most recent news for this artist
getNews(int, int, boolean)
- Method in class com.echonest.api.v4.
Artist
Gets a paged list of news for this artist
getNews(int, int)
- Method in class com.echonest.api.v4.
Artist
Gets a paged list of news for this artist
getNextInDynamicPlaylist(String, int)
- Method in class com.echonest.api.v4.
EchoNestAPI
Gets the next song in the dynamic playlist
getNextInDynamicPlaylist(String, int, int)
- Method in class com.echonest.api.v4.
EchoNestAPI
getNextInDynamicPlaylist(String)
- Method in class com.echonest.api.v4.
EchoNestAPI
Gets the next song in the dynamic playlist
getNumChannels()
- Method in class com.echonest.api.v4.
TrackAnalysis
getNumSamples()
- Method in class com.echonest.api.v4.
TrackAnalysis
getObject(String)
- Method in class com.echonest.api.v4.
ENItem
getOriginalID()
- Method in class com.echonest.api.v4.
ENItem
getPitches()
- Method in class com.echonest.api.v4.
Segment
getPlaceName()
- Method in class com.echonest.api.v4.
Location
getPreviewUrl()
- Method in class com.echonest.api.v4.
Track
Gets the preview url
getRange(int)
- Method in class com.echonest.api.v4.
YearsActive
Returns the n'th active range for the artist
getRange()
- Method in class com.echonest.api.v4.
YearsActive
Returns the full range for the artist (earliest start year, and latest end year)
getRelease()
- Method in class com.echonest.api.v4.
Audio
Gets release (album) information
getRelease()
- Method in class com.echonest.api.v4.
Review
Gets the name of the release
getReleaseImage()
- Method in class com.echonest.api.v4.
Song
getReleaseName()
- Method in class com.echonest.api.v4.
Song
getReleaseName()
- Method in class com.echonest.api.v4.
Track
Gets the release name for the track
getReviews()
- Method in class com.echonest.api.v4.
Artist
Gets the most recent reviews for this artist
getReviews(int, int)
- Method in class com.echonest.api.v4.
Artist
Gets a paged list of reviews for this artist
getReviewText()
- Method in class com.echonest.api.v4.
Review
Gets the review text
getSampleRate()
- Method in class com.echonest.api.v4.
TrackAnalysis
getSections()
- Method in class com.echonest.api.v4.
TrackAnalysis
getSegments()
- Method in class com.echonest.api.v4.
TrackAnalysis
getSession()
- Method in class com.echonest.api.v4.
Playlist
Gets the session ID for the playlist.
getSimilar(int)
- Method in class com.echonest.api.v4.
Artist
Gets a list of similar artists for this artist
getSimilarArtists(Params)
- Method in class com.echonest.api.v4.
EchoNestAPI
Gets similar artists given a set of params (See ArtistParams)
getSite()
- Method in class com.echonest.api.v4.
Biography
Gets the name of the site that is the source of the biography
getSite()
- Method in class com.echonest.api.v4.
Video
Gets the originating site of the video
getSongCatalogByID(String)
- Method in class com.echonest.api.v4.
EchoNestAPI
Gets a previously created song catalog by ID
getSongCatalogByName(String)
- Method in class com.echonest.api.v4.
EchoNestAPI
Gets a previously created song catalog by name
getSongHotttnesss()
- Method in class com.echonest.api.v4.
Song
getSongID()
- Method in class com.echonest.api.v4.
SongCatalogItem
Returns the song id
getSongID()
- Method in class com.echonest.api.v4.
Track
Gets the song ID associated with this track
getSongName()
- Method in class com.echonest.api.v4.
SongCatalogItem
returns the song name
getSongs()
- Method in class com.echonest.api.v4.
Artist
Gets the top songs for this artist
getSongs(int, int)
- Method in class com.echonest.api.v4.
Artist
Gets a paged list of songs for this artist
getSongs(Params)
- Method in class com.echonest.api.v4.
EchoNestAPI
Get info for songs based on a set of params (See SongParams)
getSongs()
- Method in class com.echonest.api.v4.
Playlist
Gets the list of songs for the playlist
getStart()
- Method in class com.echonest.api.v4.
PagedList
getStart()
- Method in class com.echonest.api.v4.
TimedEvent
getStartOfFadeOut()
- Method in class com.echonest.api.v4.
TrackAnalysis
getStatus()
- Method in class com.echonest.api.v4.
Track
Gets the analysis status for the track
getString(String)
- Method in class com.echonest.api.v4.
CatalogItem
Gets a string value by name
getString(String)
- Method in class com.echonest.api.v4.
ENItem
Returns a string at the given path within the item.
getSummary()
- Method in class com.echonest.api.v4.
Blog
Gets the blog summary
getSummary()
- Method in class com.echonest.api.v4.
News
Gets a summary of the item
getSummary()
- Method in class com.echonest.api.v4.
Review
Gets a summary of the review
getTatums()
- Method in class com.echonest.api.v4.
TrackAnalysis
getTempo()
- Method in class com.echonest.api.v4.
Song
getTempo()
- Method in class com.echonest.api.v4.
Track
Gets the tempo for the track
getTempo()
- Method in class com.echonest.api.v4.
TrackAnalysis
getTempoConfidence()
- Method in class com.echonest.api.v4.
TrackAnalysis
getTerms()
- Method in class com.echonest.api.v4.
Artist
Gets a list of top terms for this artist
getText()
- Method in class com.echonest.api.v4.
Biography
Gets the bio text
getTimbre()
- Method in class com.echonest.api.v4.
Segment
getTimeSignature()
- Method in class com.echonest.api.v4.
Song
getTimeSignature()
- Method in class com.echonest.api.v4.
Track
Gets the time signature for the track
getTimeSignature()
- Method in class com.echonest.api.v4.
TrackAnalysis
getTimeSignatureConfidence()
- Method in class com.echonest.api.v4.
TrackAnalysis
getTitle()
- Method in class com.echonest.api.v4.
Audio
Gets the audio title
getTitle()
- Method in class com.echonest.api.v4.
Song
getTitle()
- Method in class com.echonest.api.v4.
Track
Gets the title of the track
getTitle()
- Method in class com.echonest.api.v4.
Video
Gets the title of the video
getTopTerms(int)
- Method in class com.echonest.api.v4.
EchoNestAPI
Gets the most frequently occurring top terms
getTotal()
- Method in class com.echonest.api.v4.
PagedList
getTrack(String)
- Method in class com.echonest.api.v4.
Song
Gets a track for the given idspace
getTrackNew(String)
- Method in class com.echonest.api.v4.
Song
getTrackOld(String)
- Method in class com.echonest.api.v4.
Song
getURL()
- Method in class com.echonest.api.v4.
Audio
Gets the URL of the audio
getURL()
- Method in class com.echonest.api.v4.
Biography
gets the URL for the source of the biography
getURL()
- Method in class com.echonest.api.v4.
Blog
Gets the blog url
getURL()
- Method in class com.echonest.api.v4.
Image
Gets the URL of the item
getURL()
- Method in class com.echonest.api.v4.
News
Gets the URL of the item
getURL()
- Method in class com.echonest.api.v4.
Review
Gets the URL of the review
getURL()
- Method in class com.echonest.api.v4.
Video
Gets the URL of the video
getUrls()
- Method in class com.echonest.api.v4.
Artist
Gets a map of URLs for this artist
getVideos()
- Method in class com.echonest.api.v4.
Artist
Gets a list of videos for this artist
getVideos(int, int)
- Method in class com.echonest.api.v4.
Artist
Gets a paged list of videos for this artist
getWeight()
- Method in class com.echonest.api.v4.
Term
getYearsActive()
- Method in class com.echonest.api.v4.
Artist
Gets the active years for this artist
H
hasBucket(String)
- Method in class com.echonest.api.v4.
ENItem
Determines if the item has the given bucket.
hasForeignID(String)
- Method in class com.echonest.api.v4.
Artist
Determines if the artist already has a given idspace
hashCode()
- Method in class com.echonest.api.v4.
ENItem
I
IdentifySongParams
- Class in
com.echonest.api.v4
IdentifySongParams()
- Constructor for class com.echonest.api.v4.
IdentifySongParams
identifySongs(Params)
- Method in class com.echonest.api.v4.
EchoNestAPI
Identify a song given codes from the Echo Nest Fingerprinter
Image
- Class in
com.echonest.api.v4
includeAll()
- Method in class com.echonest.api.v4.
ArtistParams
includeArtistFamiliarity()
- Method in class com.echonest.api.v4.
IdentifySongParams
includeArtistFamiliarity()
- Method in class com.echonest.api.v4.
PlaylistParams
includeArtistFamiliarity()
- Method in class com.echonest.api.v4.
SongParams
includeArtistHotttnesss()
- Method in class com.echonest.api.v4.
IdentifySongParams
includeArtistHotttnesss()
- Method in class com.echonest.api.v4.
PlaylistParams
includeArtistHotttnesss()
- Method in class com.echonest.api.v4.
SongParams
includeArtistLocation()
- Method in class com.echonest.api.v4.
IdentifySongParams
includeArtistLocation()
- Method in class com.echonest.api.v4.
PlaylistParams
includeArtistLocation()
- Method in class com.echonest.api.v4.
SongParams
includeAudio()
- Method in class com.echonest.api.v4.
ArtistParams
includeAudioSummary()
- Method in class com.echonest.api.v4.
IdentifySongParams
includeAudioSummary()
- Method in class com.echonest.api.v4.
PlaylistParams
includeAudioSummary()
- Method in class com.echonest.api.v4.
SongParams
includeBiographies()
- Method in class com.echonest.api.v4.
ArtistParams
includeBlogs()
- Method in class com.echonest.api.v4.
ArtistParams
includeDocCounts()
- Method in class com.echonest.api.v4.
ArtistParams
includeFamiliarity()
- Method in class com.echonest.api.v4.
ArtistParams
includeHotttnesss()
- Method in class com.echonest.api.v4.
ArtistParams
includeImages()
- Method in class com.echonest.api.v4.
ArtistParams
includeNews()
- Method in class com.echonest.api.v4.
ArtistParams
includeReviews()
- Method in class com.echonest.api.v4.
ArtistParams
includeSongHotttnesss()
- Method in class com.echonest.api.v4.
IdentifySongParams
includeSongHotttnesss()
- Method in class com.echonest.api.v4.
PlaylistParams
includeSongHotttnesss()
- Method in class com.echonest.api.v4.
SongParams
includeSongs()
- Method in class com.echonest.api.v4.
ArtistParams
includeTerms()
- Method in class com.echonest.api.v4.
ArtistParams
includeTracks()
- Method in class com.echonest.api.v4.
IdentifySongParams
includeTracks()
- Method in class com.echonest.api.v4.
PlaylistParams
includeTracks()
- Method in class com.echonest.api.v4.
SongParams
includeURLs()
- Method in class com.echonest.api.v4.
ArtistParams
includeVideo()
- Method in class com.echonest.api.v4.
ArtistParams
includeYearsActive()
- Method in class com.echonest.api.v4.
ArtistParams
L
listArtistCatalogs()
- Method in class com.echonest.api.v4.
EchoNestAPI
List all artist catalogs created with this API key
listSongCatalogs()
- Method in class com.echonest.api.v4.
EchoNestAPI
List all song catalogs created with this API key
Location
- Class in
com.echonest.api.v4
Location(Double, Double, String)
- Constructor for class com.echonest.api.v4.
Location
N
newArtistByID(String)
- Method in class com.echonest.api.v4.
EchoNestAPI
Creates a new artist given the artist ID
newArtistByName(String)
- Method in class com.echonest.api.v4.
EchoNestAPI
Creates a new artist given the artist name
News
- Class in
com.echonest.api.v4
newTrackByID(String)
- Method in class com.echonest.api.v4.
EchoNestAPI
Creates a track from a track ID
newTrackByMD5(String)
- Method in class com.echonest.api.v4.
EchoNestAPI
Creates a track from a track ID
P
PagedList
<
T
> - Class in
com.echonest.api.v4
PagedList(int, int)
- Constructor for class com.echonest.api.v4.
PagedList
Params
- Class in
com.echonest.api.v4
Manages parameter sets for API calls
Params()
- Constructor for class com.echonest.api.v4.
Params
play(String)
- Method in class com.echonest.api.v4.
CatalogUpdater
Indicate that the given item has been played
Playlist
- Class in
com.echonest.api.v4
Represents a playlist
Playlist(List<Song>)
- Constructor for class com.echonest.api.v4.
Playlist
PlaylistParams
- Class in
com.echonest.api.v4
PlaylistParams()
- Constructor for class com.echonest.api.v4.
PlaylistParams
PlaylistParams.PlaylistSort
- Enum in
com.echonest.api.v4
PlaylistParams.PlaylistType
- Enum in
com.echonest.api.v4
R
read(int, int, String[])
- Method in class com.echonest.api.v4.
ArtistCatalog
Read items from the catalog
read(int, int)
- Method in class com.echonest.api.v4.
ArtistCatalog
Read items from the catalog
read(String[])
- Method in class com.echonest.api.v4.
ArtistCatalog
Read all the items from the catalog
read()
- Method in class com.echonest.api.v4.
ArtistCatalog
Read all the items from the catalog
read(int, int, String[])
- Method in class com.echonest.api.v4.
SongCatalog
Read items from the catalog
read(int, int)
- Method in class com.echonest.api.v4.
SongCatalog
Read items from the catalog
read(String[])
- Method in class com.echonest.api.v4.
SongCatalog
Read all the items from the catalog
read()
- Method in class com.echonest.api.v4.
SongCatalog
Read all the items from the catalog
reanalyze(boolean)
- Method in class com.echonest.api.v4.
Track
Analyze a previously uploaded track with the latest version of the analyzer.
requireTerm(String)
- Method in class com.echonest.api.v4.
DynamicPlaylistParams
Requires a term to be present in the session
Review
- Class in
com.echonest.api.v4
S
searchArtists(Params)
- Method in class com.echonest.api.v4.
EchoNestAPI
Search for artists given a set of params (See ArtistParams)
searchArtists(String)
- Method in class com.echonest.api.v4.
EchoNestAPI
Search for artists by name
searchArtists(String, int)
- Method in class com.echonest.api.v4.
EchoNestAPI
Search for artists by name and count
searchSongs(Params)
- Method in class com.echonest.api.v4.
EchoNestAPI
Search for songs given a set of params (See SongParams)
Segment
- Class in
com.echonest.api.v4
set(String, String)
- Method in class com.echonest.api.v4.
CatalogItem
Sets a key/value pair for the item
set(String, int)
- Method in class com.echonest.api.v4.
CatalogItem
Sets a key/value pair
set(String, String)
- Method in class com.echonest.api.v4.
Params
Sets a parameter and value to the parameter set
set(String, float)
- Method in class com.echonest.api.v4.
Params
set(String, boolean)
- Method in class com.echonest.api.v4.
Params
set(String, int)
- Method in class com.echonest.api.v4.
Params
setAdventurousness(float)
- Method in class com.echonest.api.v4.
PlaylistParams
Sets the desired adventurousness for the playlist.
setArtist(String)
- Method in class com.echonest.api.v4.
IdentifySongParams
setArtist(String)
- Method in class com.echonest.api.v4.
SongParams
setArtistActiveDuring(int, int)
- Method in class com.echonest.api.v4.
ArtistParams
Constrains results to artists that were active at any time during the given range
setArtistActiveDuring(int, int)
- Method in class com.echonest.api.v4.
SongParams
Constrains results to artists that were active at any time during the given range
setArtistActiveThroughout(int, int)
- Method in class com.echonest.api.v4.
ArtistParams
Constrains results to artists that were active throughout all of the the given range
setArtistActiveThroughout(int, int)
- Method in class com.echonest.api.v4.
SongParams
Constrains results to artists that were active throughout all of the the given range
setArtistEndYearAfter(int)
- Method in class com.echonest.api.v4.
PlaylistParams
Constrains results to artists that have a latest end year after the given year
setArtistEndYearAfter(int)
- Method in class com.echonest.api.v4.
SongParams
Constrains results to artists that have a latest end year after the given year
setArtistEndYearBefore(int)
- Method in class com.echonest.api.v4.
PlaylistParams
Constrains results to artists that have a latest end year before the given year
setArtistEndYearBefore(int)
- Method in class com.echonest.api.v4.
SongParams
Constrains results to artists that have a latest end year before the given year
setArtistID(String)
- Method in class com.echonest.api.v4.
ArtistCatalogItem
Sets the artist ID
setArtistID(String)
- Method in class com.echonest.api.v4.
SongCatalogItem
setArtistID(String)
- Method in class com.echonest.api.v4.
SongParams
setArtistMaxFamiliarity(float)
- Method in class com.echonest.api.v4.
PlaylistParams
setArtistMaxHotttnesss(float)
- Method in class com.echonest.api.v4.
PlaylistParams
setArtistMaxLatitude(float)
- Method in class com.echonest.api.v4.
PlaylistParams
setArtistMaxLongitude(float)
- Method in class com.echonest.api.v4.
PlaylistParams
setArtistMinFamiliarity(float)
- Method in class com.echonest.api.v4.
PlaylistParams
setArtistMinHotttnesss(float)
- Method in class com.echonest.api.v4.
PlaylistParams
setArtistMinLatitude(float)
- Method in class com.echonest.api.v4.
PlaylistParams
setArtistMinLongitude(float)
- Method in class com.echonest.api.v4.
PlaylistParams
setArtistName(String)
- Method in class com.echonest.api.v4.
ArtistCatalogItem
Sets the artist name
setArtistName(String)
- Method in class com.echonest.api.v4.
SongCatalogItem
setArtistPick(String, boolean, int)
- Method in class com.echonest.api.v4.
PlaylistParams
How songs are to be picked for artist-type playlists.
setArtistStartYearAfter(int)
- Method in class com.echonest.api.v4.
PlaylistParams
Constrains results to artists that have an earliest start year after the given year
setArtistStartYearAfter(int)
- Method in class com.echonest.api.v4.
SongParams
Constrains results to artists that have an earliest start year after the given year
setArtistStartYearBefore(int)
- Method in class com.echonest.api.v4.
PlaylistParams
Constrains results to artists that have an earliest start year before the given year
setArtistStartYearBefore(int)
- Method in class com.echonest.api.v4.
SongParams
Constrains results to artists that have an earliest start year before the given year
setChainXSPF(boolean)
- Method in class com.echonest.api.v4.
DynamicPlaylistParams
setCode(String)
- Method in class com.echonest.api.v4.
IdentifySongParams
setCombined(String)
- Method in class com.echonest.api.v4.
SongParams
setDiscNumber(int)
- Method in class com.echonest.api.v4.
SongCatalogItem
setDMCA(boolean)
- Method in class com.echonest.api.v4.
PlaylistParams
setEndYearAfter(int)
- Method in class com.echonest.api.v4.
ArtistParams
Constrains results to artists that have a latest end year after the given year
setEndYearBefore(int)
- Method in class com.echonest.api.v4.
ArtistParams
Constrains results to artists that have a latest end year before the given year
setFPCode(String)
- Method in class com.echonest.api.v4.
SongCatalogItem
setGenre(String)
- Method in class com.echonest.api.v4.
SongCatalogItem
setHostName(String)
- Method in class com.echonest.api.v4.
EchoNestAPI
Sets the host to use for the API.
setID(String)
- Method in class com.echonest.api.v4.
ArtistParams
Sets the artist ID
setID(String)
- Method in class com.echonest.api.v4.
SongParams
setKey(int)
- Method in class com.echonest.api.v4.
PlaylistParams
setKey(int)
- Method in class com.echonest.api.v4.
SongParams
setLimit(boolean)
- Method in class com.echonest.api.v4.
ArtistParams
setLimit(boolean)
- Method in class com.echonest.api.v4.
PlaylistParams
setLimit(boolean)
- Method in class com.echonest.api.v4.
SongParams
setMaxArtistFamiliarity(float)
- Method in class com.echonest.api.v4.
SongParams
setMaxArtistHotttnesss(float)
- Method in class com.echonest.api.v4.
SongParams
setMaxDanceability(float)
- Method in class com.echonest.api.v4.
PlaylistParams
setMaxDanceability(float)
- Method in class com.echonest.api.v4.
SongParams
setMaxDuration(float)
- Method in class com.echonest.api.v4.
PlaylistParams
setMaxDuration(float)
- Method in class com.echonest.api.v4.
SongParams
setMaxEnergy(float)
- Method in class com.echonest.api.v4.
PlaylistParams
setMaxEnergy(float)
- Method in class com.echonest.api.v4.
SongParams
setMaxFamiliarity(float)
- Method in class com.echonest.api.v4.
ArtistParams
setMaxFamiliarity(float)
- Method in class com.echonest.api.v4.
PlaylistParams
setMaxHotttnesss(float)
- Method in class com.echonest.api.v4.
ArtistParams
setMaxLatitude(float)
- Method in class com.echonest.api.v4.
SongParams
setMaxLongitude(float)
- Method in class com.echonest.api.v4.
SongParams
setMaxLoudness(float)
- Method in class com.echonest.api.v4.
PlaylistParams
setMaxLoudness(float)
- Method in class com.echonest.api.v4.
SongParams
setMaxSongHotttnesss(float)
- Method in class com.echonest.api.v4.
SongParams
setMaxTempo(float)
- Method in class com.echonest.api.v4.
PlaylistParams
setMaxTempo(float)
- Method in class com.echonest.api.v4.
SongParams
setMinArtistFamiliarity(float)
- Method in class com.echonest.api.v4.
SongParams
setMinArtistHotttnesss(float)
- Method in class com.echonest.api.v4.
SongParams
setMinCommandTime(int)
- Method in class com.echonest.api.v4.
EchoNestAPI
Sets the minimum time between Echo Nest commands
setMinDanceability(float)
- Method in class com.echonest.api.v4.
PlaylistParams
setMinDanceability(float)
- Method in class com.echonest.api.v4.
SongParams
setMinDuration(float)
- Method in class com.echonest.api.v4.
PlaylistParams
setMinDuration(float)
- Method in class com.echonest.api.v4.
SongParams
setMinEnergy(float)
- Method in class com.echonest.api.v4.
PlaylistParams
setMinEnergy(float)
- Method in class com.echonest.api.v4.
SongParams
setMinFamiliarity(float)
- Method in class com.echonest.api.v4.
ArtistParams
setMinHotttnesss(float)
- Method in class com.echonest.api.v4.
ArtistParams
setMinimumResults(int)
- Method in class com.echonest.api.v4.
ArtistParams
Sets the minimum number of returned results
setMinLatitude(float)
- Method in class com.echonest.api.v4.
SongParams
setMinLongitude(float)
- Method in class com.echonest.api.v4.
SongParams
setMinLoudness(float)
- Method in class com.echonest.api.v4.
PlaylistParams
setMinLoudness(float)
- Method in class com.echonest.api.v4.
SongParams
setMinSongHotttnesss(float)
- Method in class com.echonest.api.v4.
SongParams
setMinTempo(float)
- Method in class com.echonest.api.v4.
PlaylistParams
setMinTempo(float)
- Method in class com.echonest.api.v4.
SongParams
setMode(int)
- Method in class com.echonest.api.v4.
PlaylistParams
setMode(int)
- Method in class com.echonest.api.v4.
SongParams
setName(String)
- Method in class com.echonest.api.v4.
ArtistParams
Sets the artist name
setRating(int)
- Method in class com.echonest.api.v4.
DynamicPlaylistParams
setRelease(String)
- Method in class com.echonest.api.v4.
IdentifySongParams
setRelease(String)
- Method in class com.echonest.api.v4.
SongCatalogItem
setResults(int)
- Method in class com.echonest.api.v4.
ArtistParams
Sets the desired number of return results
setResults(int)
- Method in class com.echonest.api.v4.
DynamicPlaylistParams
setResults(int)
- Method in class com.echonest.api.v4.
PlaylistParams
Set the maximum number of songs to return in the playlist
setResults(int)
- Method in class com.echonest.api.v4.
SongParams
setReverse(boolean)
- Method in class com.echonest.api.v4.
ArtistParams
setSongID(String)
- Method in class com.echonest.api.v4.
SongCatalogItem
Sets the Song ID
setSongMaxHotttnesss(float)
- Method in class com.echonest.api.v4.
PlaylistParams
setSongMinHotttnesss(float)
- Method in class com.echonest.api.v4.
PlaylistParams
setSongName(String)
- Method in class com.echonest.api.v4.
SongCatalogItem
Sets the song name
setSoundsLike(boolean)
- Method in class com.echonest.api.v4.
ArtistParams
setStart(int)
- Method in class com.echonest.api.v4.
ArtistParams
Sets the starting index
setStartYearAfter(int)
- Method in class com.echonest.api.v4.
ArtistParams
Constrains results to artists that have an earliest start year after the given year
setStartYearBefore(int)
- Method in class com.echonest.api.v4.
ArtistParams
Constrains results to artists that have an earliest start year before the given year
setSteerDescription(String, float)
- Method in class com.echonest.api.v4.
DynamicPlaylistParams
Sets the boost for a particular term
setTitle(String)
- Method in class com.echonest.api.v4.
IdentifySongParams
setTitle(String)
- Method in class com.echonest.api.v4.
SongParams
setTraceRecvs(boolean)
- Method in class com.echonest.api.v4.
EchoNestAPI
Enables / disables traccing of responses
setTraceSends(boolean)
- Method in class com.echonest.api.v4.
EchoNestAPI
Enables / disables tracing of sent commands
setTrackNumber(int)
- Method in class com.echonest.api.v4.
SongCatalogItem
setType(PlaylistParams.PlaylistType)
- Method in class com.echonest.api.v4.
PlaylistParams
Sets the type of the playlist.
setUrl(String)
- Method in class com.echonest.api.v4.
SongCatalogItem
setVariety(float)
- Method in class com.echonest.api.v4.
PlaylistParams
the variety of artists to be represented in the playlist.
showAll()
- Method in class com.echonest.api.v4.
Song
showAll()
- Method in class com.echonest.api.v4.
Track
showStats()
- Method in class com.echonest.api.v4.
EchoNestAPI
Shows performance and error statistics for the API
similarSongs(Params)
- Method in class com.echonest.api.v4.
EchoNestAPI
Get similar songs based on a set of params (See SongParams)
size()
- Method in class com.echonest.api.v4.
Params
Gets the number of parameters
size()
- Method in class com.echonest.api.v4.
YearsActive
Returns the number of ranges for an artist.
skip(String)
- Method in class com.echonest.api.v4.
CatalogUpdater
Indicate that the given item has been skipped
Song
- Class in
com.echonest.api.v4
Song(EchoNestAPI, String)
- Constructor for class com.echonest.api.v4.
Song
SongCatalog
- Class in
com.echonest.api.v4
SongCatalogItem
- Class in
com.echonest.api.v4
SongCatalogItem(String)
- Constructor for class com.echonest.api.v4.
SongCatalogItem
Creates a catalog item with the given item ID
SongParams
- Class in
com.echonest.api.v4
SongParams()
- Constructor for class com.echonest.api.v4.
SongParams
SORT_ARTIST_END_YEAR
- Static variable in class com.echonest.api.v4.
SongParams
SORT_ARTIST_FAMILIARITY
- Static variable in class com.echonest.api.v4.
SongParams
SORT_ARTIST_HOTTTNESSS
- Static variable in class com.echonest.api.v4.
SongParams
SORT_ARTIST_START_YEAR
- Static variable in class com.echonest.api.v4.
SongParams
SORT_DANCEABILITY
- Static variable in class com.echonest.api.v4.
SongParams
SORT_DURATION
- Static variable in class com.echonest.api.v4.
SongParams
SORT_END_YEAR
- Static variable in class com.echonest.api.v4.
ArtistParams
SORT_ENERGY
- Static variable in class com.echonest.api.v4.
SongParams
SORT_FAMILIARITY
- Static variable in class com.echonest.api.v4.
ArtistParams
SORT_HOTTTNESSS
- Static variable in class com.echonest.api.v4.
ArtistParams
SORT_KEY
- Static variable in class com.echonest.api.v4.
SongParams
SORT_LATITUDE
- Static variable in class com.echonest.api.v4.
SongParams
SORT_LONGITUDE
- Static variable in class com.echonest.api.v4.
SongParams
SORT_LOUDNESS
- Static variable in class com.echonest.api.v4.
SongParams
SORT_MODE
- Static variable in class com.echonest.api.v4.
SongParams
SORT_SONG_HOTTTNESSS
- Static variable in class com.echonest.api.v4.
SongParams
SORT_START_YEAR
- Static variable in class com.echonest.api.v4.
ArtistParams
SORT_TEMPO
- Static variable in class com.echonest.api.v4.
SongParams
sortBy(String, boolean)
- Method in class com.echonest.api.v4.
ArtistParams
sortBy(PlaylistParams.PlaylistSort, boolean)
- Method in class com.echonest.api.v4.
PlaylistParams
sortBy(String, boolean)
- Method in class com.echonest.api.v4.
SongParams
sortByFrequency(List<Term>)
- Static method in class com.echonest.api.v4.
Term
sortByWeight(List<Term>)
- Static method in class com.echonest.api.v4.
Term
steerDanceability(float)
- Method in class com.echonest.api.v4.
DynamicPlaylistParams
Steer by dancability.
steerEnergy(float)
- Method in class com.echonest.api.v4.
DynamicPlaylistParams
Steer by energy.
steerHotttnesss(float)
- Method in class com.echonest.api.v4.
DynamicPlaylistParams
Steer by hotttnesss.
steerLoudness(float)
- Method in class com.echonest.api.v4.
DynamicPlaylistParams
Steer by loudness.
steerTempo(float)
- Method in class com.echonest.api.v4.
DynamicPlaylistParams
Steer by tempo.
SUCCESS
- Static variable in exception com.echonest.api.v4.
EchoNestException
success
suggestArtists(Params)
- Method in class com.echonest.api.v4.
EchoNestAPI
Suggest artists given a set of params (See ArtistParams)
suggestArtists(String)
- Method in class com.echonest.api.v4.
EchoNestAPI
Suggest artists by name
T
Term
- Class in
com.echonest.api.v4
TimedEvent
- Class in
com.echonest.api.v4
topHotArtists(int)
- Method in class com.echonest.api.v4.
EchoNestAPI
Gets the top hotttest artists
topHotArtists(int, int)
- Method in class com.echonest.api.v4.
EchoNestAPI
Gets the top hotttest artists
topHotArtists(Params)
- Method in class com.echonest.api.v4.
EchoNestAPI
Gets the top hotttest artists based on params
toString()
- Method in class com.echonest.api.v4.
CatalogUpdater
toString()
- Method in class com.echonest.api.v4.
ENItem
toString()
- Method in class com.echonest.api.v4.
Location
toString(boolean)
- Method in class com.echonest.api.v4.
Params
toString()
- Method in class com.echonest.api.v4.
Segment
toString()
- Method in class com.echonest.api.v4.
Song
toString()
- Method in class com.echonest.api.v4.
TimedEvent
toString()
- Method in class com.echonest.api.v4.
TrackAnalysis
Track
- Class in
com.echonest.api.v4
Track.AnalysisStatus
- Enum in
com.echonest.api.v4
The status of an analysis
TrackAnalysis
- Class in
com.echonest.api.v4
U
unban(String)
- Method in class com.echonest.api.v4.
CatalogUpdater
Indicate that the given item has been unbanned
unfavorite(String)
- Method in class com.echonest.api.v4.
CatalogUpdater
Indicate that the given item is no longer a favorite
update(CatalogItem)
- Method in class com.echonest.api.v4.
CatalogUpdater
Updates the given item
uploadTrack(URL, boolean)
- Method in class com.echonest.api.v4.
EchoNestAPI
Upload a track
uploadTrack(File, boolean)
- Method in class com.echonest.api.v4.
EchoNestAPI
Upload a track
V
valueOf(String)
- Static method in enum com.echonest.api.v4.
PlaylistParams.PlaylistSort
Returns the enum constant of this type with the specified name.
valueOf(String)
- Static method in enum com.echonest.api.v4.
PlaylistParams.PlaylistType
Returns the enum constant of this type with the specified name.
valueOf(String)
- Static method in enum com.echonest.api.v4.
Track.AnalysisStatus
Returns the enum constant of this type with the specified name.
values()
- Static method in enum com.echonest.api.v4.
PlaylistParams.PlaylistSort
Returns an array containing the constants of this enum type, in the order they are declared.
values()
- Static method in enum com.echonest.api.v4.
PlaylistParams.PlaylistType
Returns an array containing the constants of this enum type, in the order they are declared.
values()
- Static method in enum com.echonest.api.v4.
Track.AnalysisStatus
Returns an array containing the constants of this enum type, in the order they are declared.
Video
- Class in
com.echonest.api.v4
W
waitForAnalysis(long)
- Method in class com.echonest.api.v4.
Track
Wait for an analysis to finish
WebDocument
- Class in
com.echonest.api.v4
Y
YearsActive
- Class in
com.echonest.api.v4
Represents years active data for an artist.
A
B
C
D
E
F
G
H
I
L
N
P
R
S
T
U
V
W
Y
Overview
Package
Class
Tree
Index
Help
PREV NEXT
FRAMES
NO FRAMES
All Classes
Use of the Echo Nest API is subject to the Echo Nest Developer Network's
terms of service


API¶
xl_link¶
-
class
xl_link.
XLDataFrame
(data=None, index=None, columns=None, dtype=None, copy=False)¶ Monkeypatched DataFrame modified by xl_link!
- to_excel modified to return an XLMap.
- XLDataFrame._constructor set to XLDataFrame -> stops reverting to normal DataFrame
Notes
Conversions from this DataFrame to Series or Panels will return regular Panels and Series, which will convert back into regular DataFrame’s upon expanding/ reducing dimensions.
See also
Pandas.DataFrame
-
to_excel
(excel_writer, sheet_name='Sheet1', na_rep='', float_format=None, columns=None, header=True, index=True, index_label=None, startrow=0, startcol=0, engine=None, merge_cells=True, encoding=None, inf_rep='inf', verbose=True, **kwargs)¶ Monkeypatched DataFrame.to_excel by xl_link!
Returns: corresponding to position of frame as it appears in excel (see XLMap for details) Return type: XLMap See also
Pandas.DataFrame.to_excel()
Note
When providing a path as excel_writer, default engine used is ‘xlsxwriter’, as xlsxwriter workbooks can only be saved once, xl_link suppresses calling excel_writer.save(), as a result, xlmap.writer.save() should be called once no further changes are to be made to the spreadsheet.
-
class
xl_link.
XLMap
(data_range, index_range, column_range, f, writer=None)¶ An object that maps a Pandas DataFrame to it’s positions on an excel spreadsheet.
Provides access to basic pandas indexers - __getitem__, loc, iloc, ix, iat and at. These indexers are modified such that they return the cell/ range of the result.
The idea is should make using the data in spreadsheet easy to access, by using Pandas indexing syntax. For example can be used to create charts more easily (see example below).
Notes
Recommended to not be created directly, instead via, XLDataFrame.to_excel.
XLMap can only go ‘one level deep’ in terms of indexing, because each indexer always returns either an XLCell, or an XLRange. The only workaround is to reduce the size of your DataFrame BEFORE you call write_frame. This limitation drastically simplifies the implementation. Examples of what WON’T WORK:
>>> xlmap.loc['Mon':'Tues', :].index AttributeError: 'XLRange' object has no attribute 'index'
>>> xlmap.index['Mon':'Tues'] # Doesn't work because index is not a Pandas Index, but an XLRange. TypeError: unsupported operand type(s) for -: 'str' and 'int'
Parameters: - index_range, column_range (data_range,) – that represents the region the DataFrame’s data sits in.
- f (DataFrame) – that has been written to excel.
-
index
¶ XLRange – range that the index column occupies
-
columns
¶ XLRange – range that the frame columns occupy
-
data
¶ XLRange – range that the frame data occupies
-
writer
¶ Pandas.ExcelWriter – writer used to create spreadsheet
-
sheet
¶ object – sheet object corresponding to sheet the frame was written to, handy if you want insert a chart into the same sheet
Examples
>>> calories_per_meal = XLDataFrame(columns=("Meal", "Mon", "Tues", "Weds", "Thur"), data={'Meal': ('Breakfast', 'Lunch', 'Dinner', 'Midnight Snack'), 'Mon': (15, 20, 12, 3), 'Tues': (5, 16, 3, 0), 'Weds': (3, 22, 2, 8), 'Thur': (6, 7, 1, 9)}) >>> calories_per_meal.set_index("Meal", drop=True, inplace=True)
Write to excel
>>> writer = pd.ExcelWriter("Example.xlsx", engine='xlsxwriter') >>> xlmap = calories_per_meal.to_excel(writer, sheet_name="XLLinked") # returns the XLMap
Create chart with XLLink
>>> workbook = writer.book >>> xl_linked_sheet = writer.sheets["XLLinked"] >>> xl_linked_chart = workbook.add_chart({'type': 'column'}) >>> for time in calories_per_meal.index: >>> xl_linked_chart.add_series({'name': time, 'categories': proxy.columns.frange, 'values': proxy.loc[time].frange})
-
at
¶ Proxy for DataFrame.at, see Pandas DataFrame at help for behaviour.
Will return location result rather than underlying data.
Returns: location corresponding to position value within spreadsheet. Return type: XLCell Example
>>> xlmap.at["Mon", "Lunch"] <XLCell: C3>
-
create_chart
(type_='scatter', values=None, categories=None, names=None, subtype=None, title=None, x_axis_name=None, y_axis_name=None)¶ Create excel chart object based off of data within the Frame.
Parameters: - type (str) – Type of chart to create.
- values (str or list or tuple) – label or list of labels to corresponding to column to use as values for each series in chart. Default all columns.
- categories (str or list or tuple) – label or list of labels to corresponding to column to use as categories for each series in chart. Default, use index for ‘scatter’ or None for everything else.
- names (str or list or tuple) – str or list of strs to corresponding to names for each series in chart. Default, column names corresponding to values.
- subtype (str) – subtype of type, only available for some chart types e.g. bar, see Excel writing package for details
- title (str) – chart title
- x_axis_name (str) – used as label on x_axis
- y_axis_name (str) – used as label on y_axis
Returns: Return type: Chart object corresponding to the engine selected
Notes
values, categories parameters can only correspond to columns.
-
df
¶ for convenience provides read-only access to the DataFrame originally written to excel.
-
f
¶ for convenience provides read-only access to the DataFrame originally written to excel.
-
iat
¶ Proxy for DataFrame.iat, see Pandas DataFrame iat help for behaviour.
Will return location result rather than underlying data.
Returns: location corresponding to position value within spreadsheet. Return type: XLCell Example
>>> xlmap.iat[3, 2] <XLCell C3>
-
iloc
¶ Proxy for DataFrame.iloc, see Pandas DataFrame iloc help for behaviour.
Will return location result rather than underlying data.
Returns: corresponding to position of DataFrame, Series or Scalar found within spreadsheet. Return type: XLCell or XLRange Example
>>> xlmap.iloc[3, :] <XLRange: A2:D2>
-
ix
¶ Proxy for DataFrame.ix, see Pandas DataFrame ix help for behaviour. (That said this is deprecated since 0.20!)
Will return location result rather than underlying data.
Returns: corresponding to position of DataFrame, Series or Scalar found within spreadsheet. Return type: XLCell or XLRange Example
>>> xlmap.ix[3, :] <XLRange A2:D2>
-
xl_link.
write_frame
(f, excel_writer, to_excel_args=None)¶ Write a Pandas DataFrame to excel by calling to_excel, returning an XLMap, that can be used to determine the position of parts of f, using pandas indexing.
Parameters: - f (DataFrame) – Frame to write to excel
- excel_writer (str or ExcelWriter) – Path or existing Excel Writer to use to write frame
- to_excel_args (dict) – Additional arguments to pass to DataFrame.to_excel, see docs for DataFrame.to_excel
Returns: Mapping that corresponds to the position in the spreadsheet that frame was written to.
Return type:
-
xl_link.
get_xl_ranges
(frame_index, frame_columns, sheet_name='Sheet1', columns=None, header=True, index=True, index_label=None, startrow=0, startcol=0, merge_cells=True)¶ Deduces location of data_range, index_range and col_range within excel spreadsheet, given the parameters provided.
Does not require an actual DataFrame, which could be useful!
Parameters: - frame_index (Pandas Index or Array-like) – to determine location of index within spreadsheet.
- frame_columns (Pandas Index or Array-like) – used to determine location of column within spreadsheet.
- excel_writer (string or ExcelWriter) –
- sheet_name (str) – default ‘Sheet1’, Name of sheet which will contain DataFrame
- columns (sequence) – optional, Columns to write
- header (bool or list of strings,) – default True Write out the column names. If a list of strings is given it is assumed to be aliases for the column names
- index (bool) – default True. Write row names (index)
- index_label (str or sequence) – default None. Column label for index column(s) if desired. If None is given, and header and index are True, then the index names are used. A sequence should be given if the DataFrame uses MultiIndex.
- startrow (int) – upper left cell row to dump data frame
- startcol (int) – upper left cell column to dump data frame
- merge_cells (bool) – default True. Write MultiIndex and Hierarchical Rows as merged cells.
Returns: - data_range, index_range, col_range (XLRange) – Each range represents where the data, index and columns can be found on the spreadsheet
- empty_f (DatFrame) – an empty DataFrame with matching Indices.
xl_types.py¶
-
class
xl_link.xl_types.
XLRange
(start, stop)¶ Represents a range in an Excel spreadsheet
Parameters: -
start
¶ XLCell – corresponding to start cell
-
stop
¶ XLCell – corresponding to stop cell
-
sheet
¶ str – name of sheet range exists in
Examples
Using __init__
>>> start = XLCell.from_cell('A1') >>> stop = XLCell.from_cell('B7') >>> XLRange(start, stop) <XLRange: A1:B7>
Notes
Upon initialisation, if start and stop are not from the same sheet, an assertion error is raised.
start and stop are attributes that can be accessed and modified directly.
All methods are designed to return new objects, preserving the state of self.
See also
-
frange
¶ Gets the Excel range this object represents, for use in excel formulas
Returns: representing this range in excel notation for use in excel formulas (e.g. “’{sheet}’!{start}:{stop}” Return type: str Examples
>>> start = XLCell.from_cell('A1') >>> stop = XLCell.from_cell('B7') >>> range = XLRange(start, stop) >>> range.frange "'Sheet1'!A1:B7"
-
classmethod
from_frange
(frange)¶ Alternative constructor
Parameters: frange (str) – str in excel formula notation (e.g. “‘Sheet1’!A1:B20”), representing excel range. Returns: initialised XLRange Return type: XLRange
-
classmethod
from_range
(range, sheet='Sheet1')¶ Alternative constructor
Parameters: - range (str) – str in excel notation (e.g. ‘A1:B20’), representing excel range.
- sheet (str) – sheet range belongs to, default=’Sheet1’
Returns: initialised XLRange
Return type:
-
iterrows
()¶ Iterate over each row of self, yields each row as XLRange
Yields: XLRange – corresponding to current row
-
range
¶ Gets the Excel range this object represents
Returns: representing this range in excel notation Return type: str Examples
>>> start = XLCell.from_cell('A1') >>> stop = XLCell.from_cell('B7') >>> range = XLRange(start, stop) >>> range.range 'A1:B7'
-
rowcol_rowcol
¶ Coordinates of start and stop
Returns: - start.row, stop.col (tuple) – start position in rows and column num (start.row, start.col)
- stop.row, stop.col (tuple) – stop position in rows and column num (stop.row, stop.col)
-
shape
¶ returns: representing shape of XLRange in form (height, width) :rtype: tuple
-
trans
(row, col)¶ Short for XLRange.translate
See also
-
translate
(row, col)¶ Translates whole range by row, col.
Parameters: - row (int) – corresponding to movement in row direction (+ve down the spreadsheet)
- col (int) – corresponding to movement in col direction (+ve right across the spreadsheet)
Returns: new with translation applied
Return type: Notes
This moves the whole range, and cannot be used to change the shape of self.
-
-
class
xl_link.xl_types.
XLCell
(row, col, sheet='Sheet1')¶ Represents the location of a cell in an Excel spreadsheet
Parameters: - row (int) – corresponding to cell row number (0 indexed)
- col (int) – corresponding to cell col number (0 indexed)
- sheet (str) – corresponding to the sheet the cell is in, default=’Sheet1’
-
row
¶ int – corresponding to cell row number (0 indexed)
-
col
¶ int – corresponding to cell col number (0 indexed)
-
sheet
¶ str – corresponding to the sheet the cell is in, default=’Sheet1’
Examples
>>> XLCell(0, 5, 'Accounts') <XLCell: F1>
>>> XLCell.from_cell('F1', 'Accounts') <XLCell: F1>
>>> XLCell.from_fcell("'Accounts'!F1") <XLCell: F1>
Notes
sheet can be set to None if desired, keep in mind it defaults to ‘Sheet1’, mostly for convenience.
row, col and sheet are attributes that can be accessed and set directly.
All methods are designed to return new objects, preserving the state of self.
See also
-
cell
¶ Gets the cell location str.
Returns: cell location in excel notation Return type: str Examples
>>> cell = XLCell(0, 5, 'Accounts') >>> cell.cell 'F1'
-
fcell
¶ Gets the cell location for use in excel formulas.
Returns: cell location in excel notation, in ‘{sheet}’!{cell} form Return type: str Examples
>>> cell = XLCell(0, 5, 'Accounts') >>> cell.fcell "'Accounts'!F1"
-
classmethod
from_cell
(cell, sheet='Sheet1')¶ Alternative constructor
Parameters: - cell (str) – cell in excel notation (e.g. ‘A1’), representing cell location.
- sheet (sheet) – sheet cell belongs to, default=’Sheet1’
Returns: Initialised XLCell
Return type:
-
classmethod
from_fcell
(fcell)¶ Alternative constructor
Parameters: fcell (str) – cell in excel formula notation (e.g. “‘Sheet1’!A1”), representing cell location. Returns: Initialised XLCell Return type: XLCell
-
range_between
(other)¶ Get XLRange between this cell and other.
Parameters: other (XLCell) – other XLCell that makes up stop of excel range Returns: range between this cell and other Return type: XLRange Example
>>> start = XLCell.from_cell('A1') >>> stop = XLCell.from_cell('B7') >>> start.range_between(stop) <XLRange: A1:B7>
-
rowcol
¶ Coordinates of cell
Returns: row, col – (row, col) corresponding to location of cell Return type: tuple(int, int)
-
trans
(row, col)¶ Short for XLCell.translate
See also
-
translate
(row, col)¶ Returns new XLCell with translation applied
Parameters: - row (int) – corresponding to movement in row direction (+ve down the spreadsheet)
- col (int) – corresponding to movement in col direction (+ve right across the spreadsheet)
Returns: new cell with translation applied
Return type:
chart_wrapper.py¶
-
xl_link.chart_wrapper.
create_chart
(workbook, engine, type_, values, categories, names, subtype=None, title=None, x_axis_name=None, y_axis_name=None)¶ Create a chart object corresponding to given engine, within workbook.
Parameters: - workbook (object) – to insert chart into, either XlsxWriter.Workbooks or openpyxl Workbooks.
- engine (str) – representing engine to use, either XlsxWriter.Workbooks or openpyxl Workbooks.
- type (str) – representing chart type, see engine docs for options e.g. ‘line’.
- values (XLRange or sequence of XLRanges) – use as values for each series/ data set (Excel equivalent to y data).
- categories (XLRange or sequence of XLRanges) – use as categories for each series/ data set (Excel equivalent to x data).
- names (str/ sequence of str) – use as name for each series/ data set (Excel uses this to label each dataset).
- subtype (str) – representing chart subtype, see engine docs for details.
Returns: chart – populated chart object corresponding to engine’s chart type.
Return type: object
-
class
xl_link.chart_wrapper.
AbstractChartWrapper
(book, type_, subtype=None, engine=None)¶ Wraps around excel writer module, for use by create_chart.