org.dspace.app.util

Class DCInputSet

java.lang.Object

org.dspace.app.util.DCInputSet

public class DCInputSet
extends java.lang.Object

Class representing all DC inputs required for a submission, organized into pages

Version:

$Revision$

Author:

Brian S. Hughes, based on work by Jenny Toves, OCLC

Constructor Summary

Constructors

Constructor and Description
DCInputSet(java.lang.String formName, java.util.List<java.util.List<java.util.Map<java.lang.String,java.lang.String>>> pages, java.util.Map<java.lang.String,java.util.List<java.lang.String>> listMap) constructor

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getFormName() Return the name of the form that defines this input set
int	getNumberPages() Return the number of pages in this input set
DCInput[]	getPageRows(int pageNum, boolean addTitleAlternative, boolean addPublishedBefore) Get all the rows for a page from the form definition
boolean	isDefinedMultTitles() Does this set of inputs include an alternate title field?
boolean	isDefinedPubBefore() Does this set of inputs include the previously published fields?
boolean	isFieldPresent(java.lang.String fieldName) Does the current input set define the named field? Scan through every field in every page of the input set

Methods inherited from class java.lang.Object

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

Constructor Detail

DCInputSet

public DCInputSet(java.lang.String formName,
          java.util.List<java.util.List<java.util.Map<java.lang.String,java.lang.String>>> pages,
          java.util.Map<java.lang.String,java.util.List<java.lang.String>> listMap)

constructor

Method Detail

getFormName

public java.lang.String getFormName()

Return the name of the form that defines this input set

Returns:

formName the name of the form

getNumberPages

public int getNumberPages()

Return the number of pages in this input set

Returns:

number of pages

getPageRows

public DCInput[] getPageRows(int pageNum,
                    boolean addTitleAlternative,
                    boolean addPublishedBefore)

Get all the rows for a page from the form definition

Parameters:

pageNum - desired page within set

addTitleAlternative - flag to add the additional title row

addPublishedBefore - flag to add the additional published info

Returns:

an array containing the page's displayable rows

isDefinedMultTitles

public boolean isDefinedMultTitles()

Does this set of inputs include an alternate title field?

Returns:

true if the current set has an alternate title field

isDefinedPubBefore

public boolean isDefinedPubBefore()

Does this set of inputs include the previously published fields?

Returns:

true if the current set has all the prev. published fields

isFieldPresent

public boolean isFieldPresent(java.lang.String fieldName)

Does the current input set define the named field? Scan through every field in every page of the input set

Returns:

true if the current set has the named field