Package org.intermine.client.services

Class ListService.ListCreationInfo

java.lang.Object

org.intermine.client.services.ListService.ListOperationInfo

org.intermine.client.services.ListService.ListCreationInfo

Enclosing class:

ListService

public class ListService.ListCreationInfo
extends ListService.ListOperationInfo

An abstraction of the combination of options that can be specified to generate a new list in a list creation operation. This object has facilities for supplying the minimum amount of information, including automatically generating unused list names.

Constructor Summary

Constructors

Constructor	Description
ListCreationInfo(java.lang.String type)	Create a new options bundle with all possible optional values set to their defaults.
ListCreationInfo(java.lang.String type, java.lang.String name)	Create a new options bundle, with the name taken from the supplied value.
ListCreationInfo(java.lang.String type, java.lang.String name, java.lang.String description)	Create a new options bundle, with the name and description taken from the supplied value.
ListCreationInfo(java.lang.String type, java.lang.String name, java.lang.String description, java.util.Collection<? extends java.lang.String> tags)	Create a new options bundle, specifying all parameters.
ListCreationInfo(org.intermine.pathquery.PathQuery pq)	Create a new options bundle, specifying the query to use to find objects with.
ListCreationInfo(org.intermine.pathquery.PathQuery pq, java.lang.String name)	Create a new options bundle, specifying the name.
ListCreationInfo(org.intermine.pathquery.PathQuery pq, java.lang.String name, java.lang.String description)	Create a new options bundle, specifying the name and the description.
ListCreationInfo(org.intermine.pathquery.PathQuery pq, java.lang.String name, java.lang.String description, java.util.Collection<? extends java.lang.String> tags)	Create a new options bundle, specifying all parameters.

Method Summary

Modifier and Type	Method	Description
void	setContent(java.io.File ids)	Set the content for this creation request as coming from a file on the file-system.
void	setContent(java.io.InputStream is)	Set the content for this creation request as coming from an InputStream.
void	setContent(java.lang.String ids)	Set the content as coming from a string.
void	setContent(java.lang.String... identifiers)	Set the content for this request as coming from a set of strings, with each string representing one identifier.
void	setContent(java.util.Collection<java.lang.String> ids)	Set the content for this request as coming from a set of strings, with each string representing one identifier.
void	setContent(org.intermine.pathquery.PathQuery pq)	Set the content for this request as a query to run to find objects with.

Methods inherited from class org.intermine.client.services.ListService.ListOperationInfo

addTag, addTags, getTagString, getUnusedListName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ListCreationInfo

public ListCreationInfo(java.lang.String type)

Create a new options bundle with all possible optional values set to their defaults.

Parameters:

type - The class of the objects the new list will hold. This must be a valid class in the service's data-model.

ListCreationInfo

public ListCreationInfo(org.intermine.pathquery.PathQuery pq)

Create a new options bundle, specifying the query to use to find objects with.

Parameters:

pq - A query to run to collect the objects in the new list. This query must only have one output column (the object id).

ListCreationInfo

public ListCreationInfo(org.intermine.pathquery.PathQuery pq,
                        java.lang.String name)

Create a new options bundle, specifying the name.

Parameters:

pq - A query to run to collect the objects in the new list. This query must only have one output column (the object id).

name - The name for the new list.

ListCreationInfo

public ListCreationInfo(java.lang.String type,
                        java.lang.String name)

Create a new options bundle, with the name taken from the supplied value.

Parameters:

type - The class of the objects the new list will hold. This must be a valid class in the service's data-model.

name - The name for the new list.

ListCreationInfo

public ListCreationInfo(org.intermine.pathquery.PathQuery pq,
                        java.lang.String name,
                        java.lang.String description)

Create a new options bundle, specifying the name and the description.

Parameters:

pq - A query to run to collect the objects in the new list. This query must only have one output column (the object id).

name - The name for the new list.

description - A description to apply to the new list.

ListCreationInfo

public ListCreationInfo(java.lang.String type,
                        java.lang.String name,
                        java.lang.String description)

Create a new options bundle, with the name and description taken from the supplied value.

Parameters:

type - The class of the objects the new list will hold. This must be a valid class in the service's data-model.

name - The name for the new list.

description - A description to apply to the new list.

ListCreationInfo

public ListCreationInfo(org.intermine.pathquery.PathQuery pq,
                        java.lang.String name,
                        java.lang.String description,
                        java.util.Collection<? extends java.lang.String> tags)

Create a new options bundle, specifying all parameters.

Parameters:

pq - A query to run to collect the objects in the new list. This query must only have one output column (the object id).

name - The name for the new list.

description - A description to apply to the new list.

tags - A set of tags to apply to the new list.

ListCreationInfo

public ListCreationInfo(java.lang.String type,
                        java.lang.String name,
                        java.lang.String description,
                        java.util.Collection<? extends java.lang.String> tags)

Create a new options bundle, specifying all parameters.

Parameters:

type - The class of the objects the new list will hold. This must be a valid class in the service's data-model.

name - The name for the new list.

description - A description to apply to the new list.

tags - A set of tags to apply to the new list.

Method Detail

setContent

public void setContent(java.io.File ids)

Set the content for this creation request as coming from a file on the file-system.

Parameters:

ids - The file to get ids from.

setContent

public void setContent(java.io.InputStream is)
                throws java.io.IOException

Set the content for this creation request as coming from an InputStream.

Parameters:

is - The source of the content.

Throws:

java.io.IOException - If there is a problem reading from the stream.

setContent

public void setContent(java.util.Collection<java.lang.String> ids)

Set the content for this request as coming from a set of strings, with each string representing one identifier. Before transmission, these identifiers will be escaped and joined in such as way as to ensure they are handled as individual identifiers, even if they contain spaces.

Parameters:

ids - The identifiers to use as content.

setContent

public void setContent(java.lang.String... identifiers)

Set the content for this request as coming from a set of strings, with each string representing one identifier. Before transmission, these identifiers will be escaped and joined in such as way as to ensure they are handled as individual identifiers, even if they contain spaces.

Parameters:

identifiers - The identifiers to use as content.

setContent

public void setContent(java.lang.String ids)

Set the content as coming from a string. This string will be sent verbatim to the server.

Parameters:

ids - The content for the request.

setContent

public void setContent(org.intermine.pathquery.PathQuery pq)

Set the content for this request as a query to run to find objects with. Note that this query must only have one output column, which must represent the object id of the items you require.

Parameters:

pq - The query to use as a source of objects for the request.