Class for creating of requested type definition for SEC API. More...

Inheritance diagram for cz.vutbr.fit.knot.annotations.modules.suggestionManager.SecApiReqTypeDef:

Collaboration diagram for cz.vutbr.fit.knot.annotations.modules.suggestionManager.SecApiReqTypeDef:

Public Member Functions
	SecApiReqTypeDef (String name)

String	getRequestString ()

String	getRequestString (ArrayList< String > filterAtt)

void	filterAttributes (ArrayList< String > desiredAttributes, ArrayList< String > unnecessaryAttributes)

ArrayList< String >	getAvailableAttributes ()

void	setAvailableAttributes (ArrayList< String > availableAttributes)

void	addAvailableAttribute (String availableAttribute)

String	getTypeName ()

void	setTypeName (String typeName)

HashMap< String, Integer >	getPriorities ()

void	setPriorities (HashMap< String, Integer > priorities)

Integer	getPriority (String name)

void	setPriority (String name, Integer priority)

void	setAltDescDef (String desc)

String	getAltDescDef ()

SecApiReqTypeDef	clone ()

ArrayList< String >	getRequestedAttributes ()

void	setRequestedAttributes (ArrayList< String > requestedAttributes)

boolean	equals (Object obj)

int	hashCode ()

Static Public Member Functions
static void	filterTypes ()

Private Attributes
String	typeName = null

ArrayList< String >	availableAttributes = null

ArrayList< String >	requestedAttributes = null

HashMap< String, Integer >	priorities = null

String	altDescDef = null

Detailed Description

Class for creating of requested type definition for SEC API.

Class for creating of requested type definition for SEC API

Definition at line 21 of file SecApiReqTypeDef.java.

Constructor & Destructor Documentation

cz.vutbr.fit.knot.annotations.modules.suggestionManager.SecApiReqTypeDef.SecApiReqTypeDef ( String name )

Constructor

Parameters

name Type name

Definition at line 38 of file SecApiReqTypeDef.java.

Here is the caller graph for this function:

Member Function Documentation

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.SecApiReqTypeDef.addAvailableAttribute ( String availableAttribute )

Adds available attribute

Parameters

availableAttribute Available attribute

Definition at line 311 of file SecApiReqTypeDef.java.

SecApiReqTypeDef cz.vutbr.fit.knot.annotations.modules.suggestionManager.SecApiReqTypeDef.clone ( )

Clones object (creates deep copy)

Returns: Returns clone (deep copy) of the object

Definition at line 395 of file SecApiReqTypeDef.java.

Here is the call graph for this function:

boolean cz.vutbr.fit.knot.annotations.modules.suggestionManager.SecApiReqTypeDef.equals ( Object obj )

Compares this with other object and returns, whether objects are same type and have same type name.

Parameters

obj	Object to compare with

Returns: If object is same type and have same type name, returns true, false otherwise

Definition at line 437 of file SecApiReqTypeDef.java.

Here is the call graph for this function:

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.SecApiReqTypeDef.filterAttributes	(	ArrayList< String >	desiredAttributes,
		ArrayList< String >	unnecessaryAttributes
	)

Prepares list of requested attributes

If desired attributes are available, they will be used. If they are not available, unnecessary attributes will be sorted out.

Parameters

desiredAttributes	Desired attributes (what do we want)
unnecessaryAttributes	Unnecessary attributes (what we do not want)

Definition at line 121 of file SecApiReqTypeDef.java.

static void cz.vutbr.fit.knot.annotations.modules.suggestionManager.SecApiReqTypeDef.filterTypes ( )

static

Prepares list of requested type definitions

If desired attributes are available, they will be used. If they are not available, unnecessary attributes will be sorted out.

Definition at line 158 of file SecApiReqTypeDef.java.

Here is the call graph for this function:

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.SecApiReqTypeDef.getAltDescDef ( )

Return entity type description

Returns: Returns description of entity type

Definition at line 385 of file SecApiReqTypeDef.java.

Here is the caller graph for this function:

ArrayList<String> cz.vutbr.fit.knot.annotations.modules.suggestionManager.SecApiReqTypeDef.getAvailableAttributes ( )

Gets available attributes

Returns: Returns available attributes

Definition at line 293 of file SecApiReqTypeDef.java.

Here is the caller graph for this function:

HashMap<String, Integer> cz.vutbr.fit.knot.annotations.modules.suggestionManager.SecApiReqTypeDef.getPriorities ( )

Gets map with attribute priorities

Returns: Returns map with attribute priorities

Definition at line 338 of file SecApiReqTypeDef.java.

Here is the caller graph for this function:

Integer cz.vutbr.fit.knot.annotations.modules.suggestionManager.SecApiReqTypeDef.getPriority ( String name )

Gets priority for given attribute

Parameters

name	Name of attribute

Returns: Returns priority of attribute with given name

Definition at line 357 of file SecApiReqTypeDef.java.

ArrayList<String> cz.vutbr.fit.knot.annotations.modules.suggestionManager.SecApiReqTypeDef.getRequestedAttributes ( )

Gets requested attributes

Returns: Returns requested attributes

Definition at line 416 of file SecApiReqTypeDef.java.

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.SecApiReqTypeDef.getRequestString ( )

Gets part of request with given type, for example: "visual_artist": ["full_name", "wikipedia_url"]

Returns: Returns part of request with given type

Definition at line 53 of file SecApiReqTypeDef.java.

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.SecApiReqTypeDef.getRequestString ( ArrayList< String > filterAtt )

Gets part of request with given type, for example: "visual_artist": ["full_name", "wikipedia_url"]

Parameters

filterAtt List of attributes which should be selected

Returns: Returns part of request with given type

Definition at line 89 of file SecApiReqTypeDef.java.

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.SecApiReqTypeDef.getTypeName ( )

Gets type name

Returns: Returns type name

Definition at line 320 of file SecApiReqTypeDef.java.

Here is the caller graph for this function:

int cz.vutbr.fit.knot.annotations.modules.suggestionManager.SecApiReqTypeDef.hashCode ( )

Definition at line 452 of file SecApiReqTypeDef.java.

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.SecApiReqTypeDef.setAltDescDef ( String desc )

Sets entity type description

Parameters

desc	Description of entity type

Definition at line 376 of file SecApiReqTypeDef.java.

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.SecApiReqTypeDef.setAvailableAttributes ( ArrayList< String > availableAttributes )

Sets available attributes

Parameters

availableAttributes Available attributes

Definition at line 302 of file SecApiReqTypeDef.java.

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.SecApiReqTypeDef.setPriorities ( HashMap< String, Integer > priorities )

Sets map with attribute priorities

Parameters

priorities Map with attribute priorities

Definition at line 347 of file SecApiReqTypeDef.java.

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.SecApiReqTypeDef.setPriority	(	String	name,
		Integer	priority
	)

Sets priority for given attribute

Parameters

name	Name of attribute
priority	Priority of attribute

Definition at line 367 of file SecApiReqTypeDef.java.

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.SecApiReqTypeDef.setRequestedAttributes ( ArrayList< String > requestedAttributes )

Sets requested attributes

Parameters

requestedAttributes Requested attributes

Definition at line 425 of file SecApiReqTypeDef.java.

void cz.vutbr.fit.knot.annotations.modules.suggestionManager.SecApiReqTypeDef.setTypeName ( String typeName )

Sets type name

Parameters

typeName Type name

Definition at line 329 of file SecApiReqTypeDef.java.

Member Data Documentation

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.SecApiReqTypeDef.altDescDef = null

private

Definition of alternative description

Definition at line 31 of file SecApiReqTypeDef.java.

ArrayList<String> cz.vutbr.fit.knot.annotations.modules.suggestionManager.SecApiReqTypeDef.availableAttributes = null

private

Available attributes (what we can request)

Definition at line 25 of file SecApiReqTypeDef.java.

HashMap<String,Integer> cz.vutbr.fit.knot.annotations.modules.suggestionManager.SecApiReqTypeDef.priorities = null

private

Priorities of attributes

Definition at line 29 of file SecApiReqTypeDef.java.

ArrayList<String> cz.vutbr.fit.knot.annotations.modules.suggestionManager.SecApiReqTypeDef.requestedAttributes = null

private

Attributes which will be requested

Definition at line 27 of file SecApiReqTypeDef.java.

String cz.vutbr.fit.knot.annotations.modules.suggestionManager.SecApiReqTypeDef.typeName = null

private

Name of suggestion type

Definition at line 23 of file SecApiReqTypeDef.java.

The documentation for this class was generated from the following file:

src/java/cz/vutbr/fit/knot/annotations/modules/suggestionManager/SecApiReqTypeDef.java

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation