A B C D E F G H I J L M N O Q R S T U V

A

add(Expression) - Method in class com.nesstar.api.subset.Conjunction

Adds an expression to this conjunction.

add(Expression) - Method in class com.nesstar.api.subset.Disjunction

Adds an expression to this disjunction.

add(Expression) - Method in class com.nesstar.api.subset.Junction

addChild(NesstarTreeNode) - Method in interface com.nesstar.api.NesstarTreeNode

Adds a node as a child of this one.

addChild(NesstarTreeNode, int) - Method in interface com.nesstar.api.NesstarTreeNode

Adds a node as a child of this one and puts it in the position defined by position.

addChild(NesstarTreeObject) - Method in interface com.nesstar.api.NesstarTreeNode

Creates a new child node with the payload as user object.

addChild(NesstarTreeObject, int) - Method in interface com.nesstar.api.NesstarTreeNode

Creates a new child node with the payload as user object.

addChild(Map<Locale, String>, Map<Locale, String>) - Method in interface com.nesstar.api.NesstarTreeNode

Add a new child with no payload object - but that allows children.

addRole(Role) - Method in interface com.nesstar.api.User

Add a role for the user.

allowsChildren() - Method in interface com.nesstar.api.NesstarTreeNode

Indicates whether this node can have children.

and(Expression, Expression) - Static method in class com.nesstar.api.subset.CaseSubset

A logical "and" clause.

available() - Method in class com.nesstar.api.ResultStream

Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next invocation of a method for this input stream.

B

Bank<T extends NesstarBankObject> - Interface in com.nesstar.api

A repository containing all objects of a particular type hosted by a particular Nesstar server.

C

CaseSubset - Class in com.nesstar.api.subset

Represents a case subset used in many statistical operations.

CaseSubset(Expression) - Constructor for class com.nesstar.api.subset.CaseSubset

Sole constructor.

Category - Interface in com.nesstar.api

A category statistic for a discrete variable.

clear() - Method in interface com.nesstar.api.NesstarDB

Clears the cache to release memory.

close() - Method in class com.nesstar.api.ResultStream

Closes this input stream and releases any system resources associated with the stream.

com.nesstar.api - package com.nesstar.api

This is the main package containing the interfaces representing Nesstar entities, among other things.

com.nesstar.api.analysis - package com.nesstar.api.analysis

The part of the API that deals with results of microdata analysis.

com.nesstar.api.subset - package com.nesstar.api.subset

This part of the API deals with case subsetting for analysis and data download.

compile(String, Server) - Static method in class com.nesstar.api.subset.CaseSubset

Compiles a subset string to a CaseSubset object.

ComplexDdiElement - Interface in com.nesstar.api

Represents a DDI element with attributes and/or subelements.

Conjunction - Class in com.nesstar.api.subset

A conjunction ("and") of two or more subexpressions.

Conjunction(Expression...) - Constructor for class com.nesstar.api.subset.Conjunction

Sole constructor.

createRole(String, String, String) - Method in interface com.nesstar.api.Server

Create a new role.

createUser(String, String, Role...) - Method in interface com.nesstar.api.Server

Create a new user on the server.

D

DdiElement - Interface in com.nesstar.api

Represents an element in a DDI codebook.

DdiList<T extends DdiElement> - Interface in com.nesstar.api

An unmodifiable list of DDI elements.

delete() - Method in interface com.nesstar.api.NesstarTreeNode

Removes this node from the tree.

deleteUser(String) - Method in interface com.nesstar.api.Server

Delete a user on the server.

Disjunction - Class in com.nesstar.api.subset

A disjunction ("or") of two or more subexpressions.

Disjunction(Expression...) - Constructor for class com.nesstar.api.subset.Disjunction

Sole constructor.

download(FileFormat, CaseSubset, Variable...) - Method in interface com.nesstar.api.Study

Downloads the study's data, if available.

E

EGMSResource - Interface in com.nesstar.api

An EGMSResource on a Nesstar Server.

endSession() - Method in interface com.nesstar.api.NesstarDB

Forces logout on all servers.

eq(Variable, Object) - Static method in class com.nesstar.api.subset.CaseSubset

A simple "equal to" term.

Expression - Class in com.nesstar.api.subset

A case subset expression that may consist of subexpressions nested to an arbitrary depth.

Expression() - Constructor for class com.nesstar.api.subset.Expression

Expression.Operator - Enum in com.nesstar.api.subset

An enumeration of logical operators

F

FileFormat - Enum in com.nesstar.api

An enumeration of data file formats supported by Nesstar.

G

ge(Variable, Object) - Static method in class com.nesstar.api.subset.CaseSubset

A simple "greater than or equal to" term.

getAll() - Method in interface com.nesstar.api.Bank

Gets all objects in this Bank.

getBank(Class<T>) - Method in interface com.nesstar.api.Server

Gets a Bank implementation containing objects according to type.

getBreakVariables() - Method in interface com.nesstar.api.analysis.Table

Gets the break vars aka. dimensions.

getCategories() - Method in interface com.nesstar.api.Variable

Returns all category statistics in this variable.

getCellValue(Statistic, Object[]) - Method in interface com.nesstar.api.analysis.Table

Gets a value from the n-dimensional table.

getChild(int) - Method in interface com.nesstar.api.NesstarTreeNode

Gets the child node at a specific position.

getChildCount() - Method in interface com.nesstar.api.NesstarTreeNode

getChildren() - Method in interface com.nesstar.api.NesstarTreeNode

Gets a list of the children in this node.

getCurrentUser() - Method in interface com.nesstar.api.Server

Gets the current user.

getDDI() - Method in interface com.nesstar.api.Study

Gets the entire DDI source.

getDescription() - Method in interface com.nesstar.api.NesstarTreeNode

Get the description of the node.

getDescription() - Method in interface com.nesstar.api.Role

Returns a more detailed (unstructured) description of the Role.

getElement(String) - Method in interface com.nesstar.api.ComplexDdiElement

Returns a subelement of this element.

getExpression() - Method in class com.nesstar.api.subset.CaseSubset

Gets the case subset expression.

getFileURI() - Method in interface com.nesstar.api.EGMSResource

This method returns the URI to the actual resource, be it a web-page or other kind of document.

getId() - Method in interface com.nesstar.api.NesstarObject

The object's local id

getId() - Method in interface com.nesstar.api.Role

Returns the Id of the Role (e.g.

getInstance() - Static method in class com.nesstar.api.NesstarDBFactory

Returns an instance of an implementation of NesstarDB.

getLabel() - Method in interface com.nesstar.api.NesstarObject

Gets a descriptive label for this object.

getLabel() - Method in interface com.nesstar.api.NesstarTreeNode

Get this node's label.

getMeasureVar() - Method in interface com.nesstar.api.analysis.Table

Gets the measure variable, or null if there is no measure variable.

getMimeType() - Method in class com.nesstar.api.ResultStream

Gets the mime type of the resource.

getName() - Method in interface com.nesstar.api.Role

Returns the Name of the Role (e.g.

getName() - Method in interface com.nesstar.api.User

Returns the freetext name of the user (for example "John Smith").

getOutput(StatOutputFormat) - Method in interface com.nesstar.api.analysis.Table

Returns the data as a stream in some format.

getParent() - Method in interface com.nesstar.api.NesstarTreeNode

Gets the node that has this node as one of its children.

getPreferredLanguages() - Method in interface com.nesstar.api.NesstarDB

Gets the preferred languages for multilingual objects.

getProperties(String) - Method in interface com.nesstar.api.EGMSResource

Returns an array of properties from an EGMSResource.

getProperty(String) - Method in interface com.nesstar.api.EGMSResource

Returns a given property from an EGMSResource.

getRoles() - Method in interface com.nesstar.api.User

Returns the Roles associated with this user.

getServer() - Method in interface com.nesstar.api.Bank

Gets the server to which this Bank belongs.

getServer(String, int) - Method in interface com.nesstar.api.NesstarDB

Returns a server object corresponding to a Nesstar server.

getStatistics() - Method in interface com.nesstar.api.analysis.Table

Gets the statistics available to describe the measure variable.

getStudy() - Method in interface com.nesstar.api.Variable

Gets this variable's study.

getTimeStamp() - Method in interface com.nesstar.api.NesstarObject

Date of last modification.

getTreeRoot() - Method in interface com.nesstar.api.Server

Get the root node of the server's object tree.

getType() - Method in interface com.nesstar.api.Bank

Gets the type of object in this bank.

getType() - Method in interface com.nesstar.api.SimpleDdiElement

Gets the type of value.

getUri() - Method in class com.nesstar.api.ResultStream

Gets the URL to the resource.

getUserId() - Method in interface com.nesstar.api.User

Returns the user id, i.e. the id that is used to log in (for example "johnsmith").

getUserObject() - Method in interface com.nesstar.api.NesstarTreeNode

Get the object this node represents.

getUsersWithSpecifiedRole(Role) - Method in interface com.nesstar.api.Server

Get a list of users associated with a specific role.

getValue() - Method in interface com.nesstar.api.Category

Returns the value of this category.

getValue() - Method in interface com.nesstar.api.SimpleDdiElement

Gets the actual vaule of the element.

getVariableGroups() - Method in interface com.nesstar.api.Study

Returns all top-level variable groups in this study.

getVariableGroups() - Method in interface com.nesstar.api.VariableGroup

Returns all subgroups directly contained in this variable group.

getVariables() - Method in interface com.nesstar.api.Study

Returns all variables in this study.

getVariables() - Method in interface com.nesstar.api.VariableGroup

Returns all variables directly contained in this variable group.

gt(Variable, Object) - Static method in class com.nesstar.api.subset.CaseSubset

A simple "greater than" term.

H

hasData() - Method in interface com.nesstar.api.Study

Checks if the study has data avaiable.

I

IllegalTreeOperationException - Exception in com.nesstar.api

Thrown to indicate that an illegal tree operation, such as trying to add a child to a node that can't have children, has been attempted.

IllegalTreeOperationException(String) - Constructor for exception com.nesstar.api.IllegalTreeOperationException

J

Junction - Class in com.nesstar.api.subset

This class contains common code for Conjunction and Disjunction.

Junction(Expression...) - Constructor for class com.nesstar.api.subset.Junction

L

le(Variable, Object) - Static method in class com.nesstar.api.subset.CaseSubset

A simple "less than or equal to" term.

login(String, String) - Method in interface com.nesstar.api.Server

Login to the Nesstar server.

lookup(URI) - Method in interface com.nesstar.api.NesstarDB

Looks up a NesstarObject by its URI.

lt(Variable, Object) - Static method in class com.nesstar.api.subset.CaseSubset

A simple "less than" term.

M

mark(int) - Method in class com.nesstar.api.ResultStream

Marks the current position in this input stream.

markSupported() - Method in class com.nesstar.api.ResultStream

Tests if this input stream supports the mark and reset methods.

moveTo(NesstarTreeNode) - Method in interface com.nesstar.api.NesstarTreeNode

Moves this node to another location.

moveTo(NesstarTreeNode, int) - Method in interface com.nesstar.api.NesstarTreeNode

Moves this node to another location and puts it at the given position.

N

ne(Variable, Object) - Static method in class com.nesstar.api.subset.CaseSubset

A simple "not equal to" term.

Negation - Class in com.nesstar.api.subset

A negation ("not") of an expression

Negation(Expression) - Constructor for class com.nesstar.api.subset.Negation

Sole constructor.

NesstarBankObject - Interface in com.nesstar.api

A NesstarObject accessible via a Bank.

NesstarDB - Interface in com.nesstar.api

A local cache for nesstar objects.

NesstarDBFactory - Class in com.nesstar.api

A factory for instantiating an implementation of NesstarDB.

NesstarList<T extends NesstarObject> - Interface in com.nesstar.api

An unmodifiable list of Nesstar Elements.

NesstarObject - Interface in com.nesstar.api

Base interface for all Nesstar objects.

NesstarTreeNode - Interface in com.nesstar.api

Defines the requirements for nodes in a tree representation of a Nesstar server.

NesstarTreeObject - Interface in com.nesstar.api

A NesstarObject which may serve as payload in a NesstarTreeNode.

NotAuthorizedException - Exception in com.nesstar.api

Thrown to indicate that access has been denied.

NotAuthorizedException() - Constructor for exception com.nesstar.api.NotAuthorizedException

O

or(Expression, Expression) - Static method in class com.nesstar.api.subset.CaseSubset

A logical "or" clause.

Q

Question - Interface in com.nesstar.api

A survey question.

R

read() - Method in class com.nesstar.api.ResultStream

Reads the next byte of data from the input stream.

read(byte[]) - Method in class com.nesstar.api.ResultStream

Reads some number of bytes from the input stream and stores them into the buffer array b.

read(byte[], int, int) - Method in class com.nesstar.api.ResultStream

Reads up to len bytes of data from the input stream into an array of bytes.

reload() - Method in interface com.nesstar.api.NesstarObject

Reloads this object from the server.

removeChild(NesstarTreeNode) - Method in interface com.nesstar.api.NesstarTreeNode

Remove a child node from this node's children.

removeRole(String) - Method in interface com.nesstar.api.Server

Remove a role from the server.

removeRole(Role) - Method in interface com.nesstar.api.User

Remove a role from the user.

reset() - Method in class com.nesstar.api.ResultStream

Repositions this stream to the position at the time the mark method was last called on this input stream.

ResultStream - Class in com.nesstar.api

Wrapper for a resource that is streamed from the nesstar server.

ResultStream(String, InputStream) - Constructor for class com.nesstar.api.ResultStream

Creates a ResultStream that wraps some other stream.

ResultStream(String, InputStream, URI) - Constructor for class com.nesstar.api.ResultStream

Creates a ResultStream that wraps some other stream.

Role - Interface in com.nesstar.api

A Role on a Nesstar Server.

S

Server - Interface in com.nesstar.api

A representation of a Nesstar Server.

setDescription(Map<Locale, String>) - Method in interface com.nesstar.api.NesstarTreeNode

Set the description of the node.

setImplementationClass(String) - Static method in class com.nesstar.api.NesstarDBFactory

Sets the type to be returned by getInstance().

setLabel(Map<Locale, String>) - Method in interface com.nesstar.api.NesstarTreeNode

Set this node's label(s).

setPreferredLanguages(Locale...) - Method in interface com.nesstar.api.NesstarDB

Sets the preferred language for multilingual objects.

setSession(String) - Method in interface com.nesstar.api.NesstarDB

Sets user session for the current thread.

SimpleDdiElement<T> - Interface in com.nesstar.api

A DDI element with a simple value such as a String or a number.

SimpleTerm - Class in com.nesstar.api.subset

A simple term that compares a variable to a constant using one of the operators in Expression.Operator.

SimpleTerm(Variable, Object, Expression.Operator) - Constructor for class com.nesstar.api.subset.SimpleTerm

Sole constructor.

skip(long) - Method in class com.nesstar.api.ResultStream

Skips over and discards n bytes of data from this input stream.

Statistic - Enum in com.nesstar.api.analysis

An enumeration of statistical measures for variables.

StatOutputFormat - Enum in com.nesstar.api.analysis

An enumeration of formats used to serialise the results of statistical operations.

Study - Interface in com.nesstar.api

A study on a Nesstar server.

SubsetSyntaxException - Exception in com.nesstar.api.subset

Thrown to indicate a syntax error in a case subset expression

SubsetSyntaxException(String) - Constructor for exception com.nesstar.api.subset.SubsetSyntaxException

SubsetSyntaxException(String, Throwable) - Constructor for exception com.nesstar.api.subset.SubsetSyntaxException

SubsetSyntaxException(Throwable) - Constructor for exception com.nesstar.api.subset.SubsetSyntaxException

T

Table - Interface in com.nesstar.api.analysis

This class represents the result of a tabulation.

tabulate(CaseSubset, Variable[], Variable...) - Method in interface com.nesstar.api.Study

Performs a frequency cross tabulation.

tabulate(CaseSubset, Variable, Variable[], EnumSet<Statistic>, Variable...) - Method in interface com.nesstar.api.Study

Performs a cross tabulation with a measure variable.

terms - Variable in class com.nesstar.api.subset.Junction

toURI() - Method in interface com.nesstar.api.NesstarObject

The object's unique ID.

U

unparse(Unparser) - Method in class com.nesstar.api.subset.CaseSubset

This method is intended to be called by implementations of the Study interface in order to generate a subset string to be passed on to the Nesstar server.

unparseConjunction(String...) - Method in interface com.nesstar.api.subset.Unparser

Binds together subexpressions in a conjunction, e.g. "( ID('V5') = 0 ) AND ( (...)

unparseDisjunction(String...) - Method in interface com.nesstar.api.subset.Unparser

Binds together subexpressions in a conjunction, e.g. "( ID('V5') = 0 ) OR ( (...)

unparseNegation(String) - Method in interface com.nesstar.api.subset.Unparser

Negates an expression, e.g.

Unparser - Interface in com.nesstar.api.subset

An implementation of this interface is required to call the unparse method in CaseSubset.

unparseSimpleTerm(Variable, Object, Expression.Operator) - Method in interface com.nesstar.api.subset.Unparser

Generate a string representation of a simple term, for example ID('V22') = 5.23452.

User - Interface in com.nesstar.api

A user on a Nesstar server.

V

valueOf(String) - Static method in enum com.nesstar.api.analysis.Statistic

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.nesstar.api.analysis.StatOutputFormat

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.nesstar.api.FileFormat

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.nesstar.api.subset.Expression.Operator

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.nesstar.api.analysis.Statistic

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.nesstar.api.analysis.StatOutputFormat

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.nesstar.api.FileFormat

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.nesstar.api.subset.Expression.Operator

Returns an array containing the constants of this enum type, in the order they are declared.

Variable - Interface in com.nesstar.api

A variable in a Nesstar study.

VariableGroup - Interface in com.nesstar.api

A variable group in a Nesstar study.

A B C D E F G H I J L M N O Q R S T U V