com.yahoo.application

Class Application.Builder

java.lang.Object

com.yahoo.application.Application.Builder

Enclosing class:

Application

@Beta
public static class Application.Builder
extends Object

A wrapper around ApplicationBuilder that generates a services.xml

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Application.Builder.Container

Field Summary

Fields

Modifier and Type	Field and Description
private Map<String,Application.Builder.Container>	containers
private static String	DEFAULT_CHAIN
private Networking	networking
private Path	path
private static ThreadLocal<Random>	random

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
private Application	build()
Application.Builder	container(String id, Application.Builder.Container container)
private void	createFile(Path path, String content)
Application.Builder	documentType(String name, String searchDefinition)
Application.Builder	expressionInclude(String name, String searchDefinition)
private void	generateXml()
private static int	getRandomPort()
private static String	getResourceFile(String resource) Get the file name (path) of a resource or fail if it can not be found
private static File	getTempDir() Get the temporary directory
private static File	makeTempDir(String prefix, String suffix) Create a temporary directory using @{link File.createTempFile()}, but creating a directory instead of a file.
private Path	nestedResource(com.yahoo.path.Path nestedPath, String name, String fileType)
Application.Builder	networking(Networking networking)
Application.Builder	queryProfile(String name, String queryProfile)
Application.Builder	queryProfileType(String name, String queryProfileType)
Application.Builder	rankExpression(String name, String rankExpressionContent)

Methods inherited from class java.lang.Object

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

Field Detail

random

private static final ThreadLocal<Random> random

DEFAULT_CHAIN

private static final String DEFAULT_CHAIN

See Also:

Constant Field Values

containers

private final Map<String,Application.Builder.Container> containers

path

private final Path path

networking

private Networking networking

Constructor Detail

Builder

public Builder()
        throws IOException

Throws:

IOException

Method Detail

container

public Application.Builder container(String id,
                                     Application.Builder.Container container)

makeTempDir

private static File makeTempDir(String prefix,
                                String suffix)
                         throws IOException

Create a temporary directory using @{link File.createTempFile()}, but creating a directory instead of a file.

Parameters:

prefix - directory prefix

suffix - directory suffix

Returns:

The created directory

Throws:

IOException - if the temporary directory could not be created

getTempDir

private static File getTempDir()

Get the temporary directory

Returns:

The temporary directory File object

getResourceFile

private static String getResourceFile(String resource)

Get the file name (path) of a resource or fail if it can not be found

Parameters:

resource - Name of desired resource

Returns:

Path of resource

createFile

private void createFile(Path path,
                        String content)
                 throws IOException

Throws:

IOException

getRandomPort

private static int getRandomPort()

Returns:

a random number between 2000 and 62000

documentType

public Application.Builder documentType(String name,
                                        String searchDefinition)
                                 throws IOException

Parameters:

name - name of document type (search definition)

searchDefinition - add this search definition to the application

Returns:

builder

Throws:

IOException - e.g.if file not found

expressionInclude

public Application.Builder expressionInclude(String name,
                                             String searchDefinition)
                                      throws IOException

Throws:

IOException

rankExpression

public Application.Builder rankExpression(String name,
                                          String rankExpressionContent)
                                   throws IOException

Parameters:

name - name of rank expression

rankExpressionContent - add this rank expression to the application

Returns:

builder

Throws:

IOException - e.g.if file not found

queryProfile

public Application.Builder queryProfile(String name,
                                        String queryProfile)
                                 throws IOException

Parameters:

name - name of query profile

queryProfile - add this queyr profile to the application

Returns:

builder

Throws:

IOException - e.g.if file not found

queryProfileType

public Application.Builder queryProfileType(String name,
                                            String queryProfileType)
                                     throws IOException

Parameters:

name - name of query profile type

queryProfileType - add this query profile type to the application

Returns:

builder

Throws:

IOException - e.g.if file not found

nestedResource

private Path nestedResource(com.yahoo.path.Path nestedPath,
                            String name,
                            String fileType)

networking

public Application.Builder networking(Networking networking)

Parameters:

networking - enable or disable networking (disabled by default)

Returns:

builder

build

private Application build()
                   throws Exception

Throws:

Exception

generateXml

private void generateXml()
                  throws Exception

Throws:

Exception