net.officefloor.frame.impl.construct.office

Class OfficeMetaDataLocatorImpl

java.lang.Object

net.officefloor.frame.impl.construct.office.OfficeMetaDataLocatorImpl

All Implemented Interfaces:

OfficeMetaDataLocator

public class OfficeMetaDataLocatorImpl
extends Object
implements OfficeMetaDataLocator

OfficeMetaDataLocator implementation.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor and Description
OfficeMetaDataLocatorImpl(OfficeMetaData officeMetaData) Initiate.

Method Summary

Modifier and Type	Method and Description
OfficeMetaDataLocator	createWorkSpecificOfficeMetaDataLocator(WorkMetaData<?> workMetaData) Creates a OfficeMetaDataLocator that defaults to the input WorkMetaData if no Work name is provided.
WorkMetaData<?>	getDefaultWorkMetaData() Obtains the default WorkMetaData.
OfficeMetaData	getOfficeMetaData() Obtains the OfficeMetaData of the Office that TaskMetaData is being located within.
TaskMetaData<?,?,?>	getTaskMetaData(String taskName) Obtains the TaskMetaData on the default WorkMetaData.
TaskMetaData<?,?,?>	getTaskMetaData(String workName, String taskName) Obtains the TaskMetaData by the Work and Task name.
WorkMetaData<?>	getWorkMetaData(String workName) Obtains the WorkMetaData by the Work name.

Methods inherited from class java.lang.Object

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

Constructor Detail

OfficeMetaDataLocatorImpl

public OfficeMetaDataLocatorImpl(OfficeMetaData officeMetaData)

Initiate.

Parameters:

officeMetaData - OfficeMetaData to find the TaskMetaData within.

Method Detail

getOfficeMetaData

public OfficeMetaData getOfficeMetaData()

Description copied from interface: OfficeMetaDataLocator

Obtains the OfficeMetaData of the Office that TaskMetaData is being located within.

Specified by:

getOfficeMetaData in interface OfficeMetaDataLocator

Returns:

OfficeMetaData of the Office that TaskMetaData is being located within.

getDefaultWorkMetaData

public WorkMetaData<?> getDefaultWorkMetaData()

Description copied from interface: OfficeMetaDataLocator

Obtains the default WorkMetaData.

Specified by:

getDefaultWorkMetaData in interface OfficeMetaDataLocator

Returns:

Default WorkMetaData.

createWorkSpecificOfficeMetaDataLocator

public OfficeMetaDataLocator createWorkSpecificOfficeMetaDataLocator(WorkMetaData<?> workMetaData)

Description copied from interface: OfficeMetaDataLocator

Creates a OfficeMetaDataLocator that defaults to the input WorkMetaData if no Work name is provided.

Specified by:

createWorkSpecificOfficeMetaDataLocator in interface OfficeMetaDataLocator

Parameters:

workMetaData - WorkMetaData of the Work to default searching for TaskMetaData.

Returns:

OfficeMetaDataLocator.

getWorkMetaData

public WorkMetaData<?> getWorkMetaData(String workName)

Description copied from interface: OfficeMetaDataLocator

Obtains the WorkMetaData by the Work name.

Specified by:

getWorkMetaData in interface OfficeMetaDataLocator

Parameters:

workName - Name of the Work.

Returns:

WorkMetaData or null if not found.

getTaskMetaData

public TaskMetaData<?,?,?> getTaskMetaData(String workName,
                                           String taskName)

Description copied from interface: OfficeMetaDataLocator

Obtains the TaskMetaData by the Work and Task name.

Specified by:

getTaskMetaData in interface OfficeMetaDataLocator

Parameters:

workName - Name of the Work that the Task is on. If null attempts to find TaskMetaData on the default WorkMetaData.

taskName - Name of the Task.

Returns:

TaskMetaData or null if not found.

getTaskMetaData

public TaskMetaData<?,?,?> getTaskMetaData(String taskName)

Description copied from interface: OfficeMetaDataLocator

Obtains the TaskMetaData on the default WorkMetaData. If no default WorkMetaData is available, this will always return null.

Specified by:

getTaskMetaData in interface OfficeMetaDataLocator

Parameters:

taskName - Name of the Task on the default Work.

Returns:

TaskMetaData or null if not found.