hadoop-mapred_0.20.0.xml 874 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484134851348613487134881348913490134911349213493134941349513496134971349813499135001350113502135031350413505135061350713508135091351013511135121351313514135151351613517135181351913520135211352213523135241352513526135271352813529135301353113532135331353413535135361353713538135391354013541135421354313544135451354613547135481354913550135511355213553135541355513556135571355813559135601356113562135631356413565135661356713568135691357013571135721357313574135751357613577135781357913580135811358213583135841358513586135871358813589135901359113592135931359413595135961359713598135991360013601136021360313604136051360613607136081360913610136111361213613136141361513616136171361813619136201362113622136231362413625136261362713628136291363013631136321363313634136351363613637136381363913640136411364213643136441364513646136471364813649136501365113652136531365413655136561365713658136591366013661136621366313664136651366613667136681366913670136711367213673136741367513676136771367813679136801368113682136831368413685136861368713688136891369013691136921369313694136951369613697136981369913700137011370213703137041370513706137071370813709137101371113712137131371413715137161371713718137191372013721137221372313724137251372613727137281372913730137311373213733137341373513736137371373813739137401374113742137431374413745137461374713748137491375013751137521375313754137551375613757137581375913760137611376213763137641376513766137671376813769137701377113772137731377413775137761377713778137791378013781137821378313784137851378613787137881378913790137911379213793137941379513796137971379813799138001380113802138031380413805138061380713808138091381013811138121381313814138151381613817138181381913820138211382213823138241382513826138271382813829138301383113832138331383413835138361383713838138391384013841138421384313844138451384613847138481384913850138511385213853138541385513856138571385813859138601386113862138631386413865138661386713868138691387013871138721387313874138751387613877138781387913880138811388213883138841388513886138871388813889138901389113892138931389413895138961389713898138991390013901139021390313904139051390613907139081390913910139111391213913139141391513916139171391813919139201392113922139231392413925139261392713928139291393013931139321393313934139351393613937139381393913940139411394213943139441394513946139471394813949139501395113952139531395413955139561395713958139591396013961139621396313964139651396613967139681396913970139711397213973139741397513976139771397813979139801398113982139831398413985139861398713988139891399013991139921399313994139951399613997139981399914000140011400214003140041400514006140071400814009140101401114012140131401414015140161401714018140191402014021140221402314024140251402614027140281402914030140311403214033140341403514036140371403814039140401404114042140431404414045140461404714048140491405014051140521405314054140551405614057140581405914060140611406214063140641406514066140671406814069140701407114072140731407414075140761407714078140791408014081140821408314084140851408614087140881408914090140911409214093140941409514096140971409814099141001410114102141031410414105141061410714108141091411014111141121411314114141151411614117141181411914120141211412214123141241412514126141271412814129141301413114132141331413414135141361413714138141391414014141141421414314144141451414614147141481414914150141511415214153141541415514156141571415814159141601416114162141631416414165141661416714168141691417014171141721417314174141751417614177141781417914180141811418214183141841418514186141871418814189141901419114192141931419414195141961419714198141991420014201142021420314204142051420614207142081420914210142111421214213142141421514216142171421814219142201422114222142231422414225142261422714228142291423014231142321423314234142351423614237142381423914240142411424214243142441424514246142471424814249142501425114252142531425414255142561425714258142591426014261142621426314264142651426614267142681426914270142711427214273142741427514276142771427814279142801428114282142831428414285142861428714288142891429014291142921429314294142951429614297142981429914300143011430214303143041430514306143071430814309143101431114312143131431414315143161431714318143191432014321143221432314324143251432614327143281432914330143311433214333143341433514336143371433814339143401434114342143431434414345143461434714348143491435014351143521435314354143551435614357143581435914360143611436214363143641436514366143671436814369143701437114372143731437414375143761437714378143791438014381143821438314384143851438614387143881438914390143911439214393143941439514396143971439814399144001440114402144031440414405144061440714408144091441014411144121441314414144151441614417144181441914420144211442214423144241442514426144271442814429144301443114432144331443414435144361443714438144391444014441144421444314444144451444614447144481444914450144511445214453144541445514456144571445814459144601446114462144631446414465144661446714468144691447014471144721447314474144751447614477144781447914480144811448214483144841448514486144871448814489144901449114492144931449414495144961449714498144991450014501145021450314504145051450614507145081450914510145111451214513145141451514516145171451814519145201452114522145231452414525145261452714528145291453014531145321453314534145351453614537145381453914540145411454214543145441454514546145471454814549145501455114552145531455414555145561455714558145591456014561145621456314564145651456614567145681456914570145711457214573145741457514576145771457814579145801458114582145831458414585145861458714588145891459014591145921459314594145951459614597145981459914600146011460214603146041460514606146071460814609146101461114612146131461414615146161461714618146191462014621146221462314624146251462614627146281462914630146311463214633146341463514636146371463814639146401464114642146431464414645146461464714648146491465014651146521465314654146551465614657146581465914660146611466214663146641466514666146671466814669146701467114672146731467414675146761467714678146791468014681146821468314684146851468614687146881468914690146911469214693146941469514696146971469814699147001470114702147031470414705147061470714708147091471014711147121471314714147151471614717147181471914720147211472214723147241472514726147271472814729147301473114732147331473414735147361473714738147391474014741147421474314744147451474614747147481474914750147511475214753147541475514756147571475814759147601476114762147631476414765147661476714768147691477014771147721477314774147751477614777147781477914780147811478214783147841478514786147871478814789147901479114792147931479414795147961479714798147991480014801148021480314804148051480614807148081480914810148111481214813148141481514816148171481814819148201482114822148231482414825148261482714828148291483014831148321483314834148351483614837148381483914840148411484214843148441484514846148471484814849148501485114852148531485414855148561485714858148591486014861148621486314864148651486614867148681486914870148711487214873148741487514876148771487814879148801488114882148831488414885148861488714888148891489014891148921489314894148951489614897148981489914900149011490214903149041490514906149071490814909149101491114912149131491414915149161491714918149191492014921149221492314924149251492614927149281492914930149311493214933149341493514936149371493814939149401494114942149431494414945149461494714948149491495014951149521495314954149551495614957149581495914960149611496214963149641496514966149671496814969149701497114972149731497414975149761497714978149791498014981149821498314984149851498614987149881498914990149911499214993149941499514996149971499814999150001500115002150031500415005150061500715008150091501015011150121501315014150151501615017150181501915020150211502215023150241502515026150271502815029150301503115032150331503415035150361503715038150391504015041150421504315044150451504615047150481504915050150511505215053150541505515056150571505815059150601506115062150631506415065150661506715068150691507015071150721507315074150751507615077150781507915080150811508215083150841508515086150871508815089150901509115092150931509415095150961509715098150991510015101151021510315104151051510615107151081510915110151111511215113151141511515116151171511815119151201512115122151231512415125151261512715128151291513015131151321513315134151351513615137151381513915140151411514215143151441514515146151471514815149151501515115152151531515415155151561515715158151591516015161151621516315164151651516615167151681516915170151711517215173151741517515176151771517815179151801518115182151831518415185151861518715188151891519015191151921519315194151951519615197151981519915200152011520215203152041520515206152071520815209152101521115212152131521415215152161521715218152191522015221152221522315224152251522615227152281522915230152311523215233152341523515236152371523815239152401524115242152431524415245152461524715248152491525015251152521525315254152551525615257152581525915260152611526215263152641526515266152671526815269152701527115272152731527415275152761527715278152791528015281152821528315284152851528615287152881528915290152911529215293152941529515296152971529815299153001530115302153031530415305153061530715308153091531015311153121531315314153151531615317153181531915320153211532215323153241532515326153271532815329153301533115332153331533415335153361533715338153391534015341153421534315344153451534615347153481534915350153511535215353153541535515356153571535815359153601536115362153631536415365153661536715368153691537015371153721537315374153751537615377153781537915380153811538215383153841538515386153871538815389153901539115392153931539415395153961539715398153991540015401154021540315404154051540615407154081540915410154111541215413154141541515416154171541815419154201542115422154231542415425154261542715428154291543015431154321543315434154351543615437154381543915440154411544215443154441544515446154471544815449154501545115452154531545415455154561545715458154591546015461154621546315464154651546615467154681546915470154711547215473154741547515476154771547815479154801548115482154831548415485154861548715488154891549015491154921549315494154951549615497154981549915500155011550215503155041550515506155071550815509155101551115512155131551415515155161551715518155191552015521155221552315524155251552615527155281552915530155311553215533155341553515536155371553815539155401554115542155431554415545155461554715548155491555015551155521555315554155551555615557155581555915560155611556215563155641556515566155671556815569155701557115572155731557415575155761557715578155791558015581155821558315584155851558615587155881558915590155911559215593155941559515596155971559815599156001560115602156031560415605156061560715608156091561015611156121561315614156151561615617156181561915620156211562215623156241562515626156271562815629156301563115632156331563415635156361563715638156391564015641156421564315644156451564615647156481564915650156511565215653156541565515656156571565815659156601566115662156631566415665156661566715668156691567015671156721567315674156751567615677156781567915680156811568215683156841568515686156871568815689156901569115692156931569415695156961569715698156991570015701157021570315704157051570615707157081570915710157111571215713157141571515716157171571815719157201572115722157231572415725157261572715728157291573015731157321573315734157351573615737157381573915740157411574215743157441574515746157471574815749157501575115752157531575415755157561575715758157591576015761157621576315764157651576615767157681576915770157711577215773157741577515776157771577815779157801578115782157831578415785157861578715788157891579015791157921579315794157951579615797157981579915800158011580215803158041580515806158071580815809158101581115812158131581415815158161581715818158191582015821158221582315824158251582615827158281582915830158311583215833158341583515836158371583815839158401584115842158431584415845158461584715848158491585015851158521585315854158551585615857158581585915860158611586215863158641586515866158671586815869158701587115872158731587415875158761587715878158791588015881158821588315884158851588615887158881588915890158911589215893158941589515896158971589815899159001590115902159031590415905159061590715908159091591015911159121591315914159151591615917159181591915920159211592215923159241592515926159271592815929159301593115932159331593415935159361593715938159391594015941159421594315944159451594615947159481594915950159511595215953159541595515956159571595815959159601596115962159631596415965159661596715968159691597015971159721597315974159751597615977159781597915980159811598215983159841598515986159871598815989159901599115992159931599415995159961599715998159991600016001160021600316004160051600616007160081600916010160111601216013160141601516016160171601816019160201602116022160231602416025160261602716028160291603016031160321603316034160351603616037160381603916040160411604216043160441604516046160471604816049160501605116052160531605416055160561605716058160591606016061160621606316064160651606616067160681606916070160711607216073160741607516076160771607816079160801608116082160831608416085160861608716088160891609016091160921609316094160951609616097160981609916100161011610216103161041610516106161071610816109161101611116112161131611416115161161611716118161191612016121161221612316124161251612616127161281612916130161311613216133161341613516136161371613816139161401614116142161431614416145161461614716148161491615016151161521615316154161551615616157161581615916160161611616216163161641616516166161671616816169161701617116172161731617416175161761617716178161791618016181161821618316184161851618616187161881618916190161911619216193161941619516196161971619816199162001620116202162031620416205162061620716208162091621016211162121621316214162151621616217162181621916220162211622216223162241622516226162271622816229162301623116232162331623416235162361623716238162391624016241162421624316244162451624616247162481624916250162511625216253162541625516256162571625816259162601626116262162631626416265162661626716268162691627016271162721627316274162751627616277162781627916280162811628216283162841628516286162871628816289162901629116292162931629416295162961629716298162991630016301163021630316304163051630616307163081630916310163111631216313163141631516316163171631816319163201632116322163231632416325163261632716328163291633016331163321633316334163351633616337163381633916340163411634216343163441634516346163471634816349163501635116352163531635416355163561635716358163591636016361163621636316364163651636616367163681636916370163711637216373163741637516376163771637816379163801638116382163831638416385163861638716388163891639016391163921639316394163951639616397163981639916400164011640216403164041640516406164071640816409164101641116412164131641416415164161641716418164191642016421164221642316424164251642616427164281642916430164311643216433164341643516436164371643816439164401644116442164431644416445164461644716448164491645016451164521645316454164551645616457164581645916460164611646216463164641646516466164671646816469164701647116472164731647416475164761647716478164791648016481164821648316484164851648616487164881648916490164911649216493164941649516496164971649816499165001650116502165031650416505165061650716508165091651016511165121651316514165151651616517165181651916520165211652216523165241652516526165271652816529165301653116532165331653416535165361653716538165391654016541165421654316544165451654616547165481654916550165511655216553165541655516556165571655816559165601656116562165631656416565165661656716568165691657016571165721657316574165751657616577165781657916580165811658216583165841658516586165871658816589165901659116592165931659416595165961659716598165991660016601166021660316604166051660616607166081660916610166111661216613166141661516616166171661816619166201662116622166231662416625166261662716628166291663016631166321663316634166351663616637166381663916640166411664216643166441664516646166471664816649166501665116652166531665416655166561665716658166591666016661166621666316664166651666616667166681666916670166711667216673166741667516676166771667816679166801668116682166831668416685166861668716688166891669016691166921669316694166951669616697166981669916700167011670216703167041670516706167071670816709167101671116712167131671416715167161671716718167191672016721167221672316724167251672616727167281672916730167311673216733167341673516736167371673816739167401674116742167431674416745167461674716748167491675016751167521675316754167551675616757167581675916760167611676216763167641676516766167671676816769167701677116772167731677416775167761677716778167791678016781167821678316784167851678616787167881678916790167911679216793167941679516796167971679816799168001680116802168031680416805168061680716808168091681016811168121681316814168151681616817168181681916820168211682216823168241682516826168271682816829168301683116832168331683416835168361683716838168391684016841168421684316844168451684616847168481684916850168511685216853168541685516856168571685816859168601686116862168631686416865168661686716868168691687016871168721687316874168751687616877168781687916880168811688216883168841688516886168871688816889168901689116892168931689416895168961689716898168991690016901169021690316904169051690616907169081690916910169111691216913169141691516916169171691816919169201692116922169231692416925169261692716928169291693016931169321693316934169351693616937169381693916940169411694216943169441694516946169471694816949169501695116952169531695416955169561695716958169591696016961169621696316964169651696616967169681696916970169711697216973169741697516976169771697816979169801698116982169831698416985169861698716988169891699016991169921699316994169951699616997169981699917000170011700217003170041700517006170071700817009170101701117012170131701417015170161701717018170191702017021170221702317024170251702617027170281702917030170311703217033170341703517036170371703817039170401704117042170431704417045170461704717048170491705017051170521705317054170551705617057170581705917060170611706217063170641706517066170671706817069170701707117072170731707417075170761707717078170791708017081170821708317084170851708617087170881708917090170911709217093170941709517096170971709817099171001710117102171031710417105171061710717108171091711017111171121711317114171151711617117171181711917120171211712217123171241712517126171271712817129171301713117132171331713417135171361713717138171391714017141171421714317144171451714617147171481714917150171511715217153171541715517156171571715817159171601716117162171631716417165171661716717168171691717017171171721717317174171751717617177171781717917180171811718217183171841718517186171871718817189171901719117192171931719417195171961719717198171991720017201172021720317204172051720617207172081720917210172111721217213172141721517216172171721817219172201722117222172231722417225172261722717228172291723017231172321723317234172351723617237172381723917240172411724217243172441724517246172471724817249172501725117252172531725417255172561725717258172591726017261172621726317264172651726617267172681726917270172711727217273172741727517276172771727817279172801728117282172831728417285172861728717288172891729017291172921729317294172951729617297172981729917300173011730217303173041730517306173071730817309173101731117312173131731417315173161731717318173191732017321173221732317324173251732617327173281732917330173311733217333173341733517336173371733817339173401734117342173431734417345173461734717348173491735017351173521735317354173551735617357173581735917360173611736217363173641736517366173671736817369173701737117372173731737417375173761737717378173791738017381173821738317384173851738617387173881738917390173911739217393173941739517396173971739817399174001740117402174031740417405174061740717408174091741017411174121741317414174151741617417174181741917420174211742217423174241742517426174271742817429174301743117432174331743417435174361743717438174391744017441174421744317444174451744617447174481744917450174511745217453174541745517456174571745817459174601746117462174631746417465174661746717468174691747017471174721747317474174751747617477174781747917480174811748217483174841748517486174871748817489174901749117492174931749417495174961749717498174991750017501175021750317504175051750617507175081750917510175111751217513175141751517516175171751817519175201752117522175231752417525175261752717528175291753017531175321753317534175351753617537175381753917540175411754217543175441754517546175471754817549175501755117552175531755417555175561755717558175591756017561175621756317564175651756617567175681756917570175711757217573175741757517576175771757817579175801758117582175831758417585175861758717588175891759017591175921759317594175951759617597175981759917600176011760217603176041760517606176071760817609176101761117612176131761417615176161761717618176191762017621176221762317624176251762617627176281762917630176311763217633176341763517636176371763817639176401764117642176431764417645176461764717648176491765017651176521765317654176551765617657176581765917660176611766217663176641766517666176671766817669176701767117672176731767417675176761767717678176791768017681176821768317684176851768617687176881768917690176911769217693176941769517696176971769817699177001770117702177031770417705177061770717708177091771017711177121771317714177151771617717177181771917720177211772217723177241772517726177271772817729177301773117732177331773417735177361773717738177391774017741177421774317744177451774617747177481774917750177511775217753177541775517756177571775817759177601776117762177631776417765177661776717768177691777017771177721777317774177751777617777177781777917780177811778217783177841778517786177871778817789177901779117792177931779417795177961779717798177991780017801178021780317804178051780617807178081780917810178111781217813178141781517816178171781817819178201782117822178231782417825178261782717828178291783017831178321783317834178351783617837178381783917840178411784217843178441784517846178471784817849178501785117852178531785417855178561785717858178591786017861178621786317864178651786617867178681786917870178711787217873178741787517876178771787817879178801788117882178831788417885178861788717888178891789017891178921789317894178951789617897178981789917900179011790217903179041790517906179071790817909179101791117912179131791417915179161791717918179191792017921179221792317924179251792617927179281792917930179311793217933179341793517936179371793817939179401794117942179431794417945179461794717948179491795017951179521795317954179551795617957179581795917960179611796217963179641796517966179671796817969179701797117972179731797417975179761797717978179791798017981179821798317984179851798617987179881798917990179911799217993179941799517996179971799817999180001800118002180031800418005180061800718008180091801018011180121801318014180151801618017180181801918020180211802218023180241802518026180271802818029180301803118032180331803418035180361803718038180391804018041180421804318044180451804618047180481804918050180511805218053180541805518056180571805818059180601806118062180631806418065180661806718068180691807018071180721807318074180751807618077180781807918080180811808218083180841808518086180871808818089180901809118092180931809418095180961809718098180991810018101181021810318104181051810618107181081810918110181111811218113181141811518116181171811818119181201812118122181231812418125181261812718128181291813018131181321813318134181351813618137181381813918140181411814218143181441814518146181471814818149181501815118152181531815418155181561815718158181591816018161181621816318164181651816618167181681816918170181711817218173181741817518176181771817818179181801818118182181831818418185181861818718188181891819018191181921819318194181951819618197181981819918200182011820218203182041820518206182071820818209182101821118212182131821418215182161821718218182191822018221182221822318224182251822618227182281822918230182311823218233182341823518236182371823818239182401824118242182431824418245182461824718248182491825018251182521825318254182551825618257182581825918260182611826218263182641826518266182671826818269182701827118272182731827418275182761827718278182791828018281182821828318284182851828618287182881828918290182911829218293182941829518296182971829818299183001830118302183031830418305183061830718308183091831018311183121831318314183151831618317183181831918320183211832218323183241832518326183271832818329183301833118332183331833418335183361833718338183391834018341183421834318344183451834618347183481834918350183511835218353183541835518356183571835818359183601836118362183631836418365183661836718368183691837018371183721837318374183751837618377183781837918380183811838218383183841838518386183871838818389183901839118392183931839418395183961839718398183991840018401184021840318404184051840618407184081840918410184111841218413184141841518416184171841818419184201842118422184231842418425184261842718428184291843018431184321843318434184351843618437184381843918440184411844218443184441844518446184471844818449184501845118452184531845418455184561845718458184591846018461184621846318464184651846618467184681846918470184711847218473184741847518476184771847818479184801848118482184831848418485184861848718488184891849018491184921849318494184951849618497184981849918500185011850218503185041850518506185071850818509185101851118512185131851418515185161851718518185191852018521185221852318524185251852618527185281852918530185311853218533185341853518536185371853818539185401854118542185431854418545185461854718548185491855018551185521855318554185551855618557185581855918560185611856218563185641856518566185671856818569185701857118572185731857418575185761857718578185791858018581185821858318584185851858618587185881858918590185911859218593185941859518596185971859818599186001860118602186031860418605186061860718608186091861018611186121861318614186151861618617186181861918620186211862218623186241862518626186271862818629186301863118632186331863418635186361863718638186391864018641186421864318644186451864618647186481864918650186511865218653186541865518656186571865818659186601866118662186631866418665186661866718668186691867018671186721867318674186751867618677186781867918680186811868218683186841868518686186871868818689186901869118692186931869418695186961869718698186991870018701187021870318704187051870618707187081870918710187111871218713187141871518716187171871818719187201872118722187231872418725187261872718728187291873018731187321873318734187351873618737187381873918740187411874218743187441874518746187471874818749187501875118752187531875418755187561875718758187591876018761187621876318764187651876618767187681876918770187711877218773187741877518776187771877818779187801878118782187831878418785187861878718788187891879018791187921879318794187951879618797187981879918800188011880218803188041880518806188071880818809188101881118812188131881418815188161881718818188191882018821188221882318824188251882618827188281882918830188311883218833188341883518836188371883818839188401884118842188431884418845188461884718848188491885018851188521885318854188551885618857188581885918860188611886218863188641886518866188671886818869188701887118872188731887418875188761887718878188791888018881188821888318884188851888618887188881888918890188911889218893188941889518896188971889818899189001890118902189031890418905189061890718908189091891018911189121891318914189151891618917189181891918920189211892218923189241892518926189271892818929189301893118932189331893418935189361893718938189391894018941189421894318944189451894618947189481894918950189511895218953189541895518956189571895818959189601896118962189631896418965189661896718968189691897018971189721897318974189751897618977189781897918980189811898218983189841898518986189871898818989189901899118992189931899418995189961899718998189991900019001190021900319004190051900619007190081900919010190111901219013190141901519016190171901819019190201902119022190231902419025190261902719028190291903019031190321903319034190351903619037190381903919040190411904219043190441904519046190471904819049190501905119052190531905419055190561905719058190591906019061190621906319064190651906619067190681906919070190711907219073190741907519076190771907819079190801908119082190831908419085190861908719088190891909019091190921909319094190951909619097190981909919100191011910219103191041910519106191071910819109191101911119112191131911419115191161911719118191191912019121191221912319124191251912619127191281912919130191311913219133191341913519136191371913819139191401914119142191431914419145191461914719148191491915019151191521915319154191551915619157191581915919160191611916219163191641916519166191671916819169191701917119172191731917419175191761917719178191791918019181191821918319184191851918619187191881918919190191911919219193191941919519196191971919819199192001920119202192031920419205192061920719208192091921019211192121921319214192151921619217192181921919220192211922219223192241922519226192271922819229192301923119232192331923419235192361923719238192391924019241192421924319244192451924619247192481924919250192511925219253192541925519256192571925819259192601926119262192631926419265192661926719268192691927019271192721927319274192751927619277192781927919280192811928219283192841928519286192871928819289192901929119292192931929419295192961929719298192991930019301193021930319304193051930619307193081930919310193111931219313193141931519316193171931819319193201932119322193231932419325193261932719328193291933019331193321933319334193351933619337193381933919340193411934219343193441934519346193471934819349193501935119352193531935419355193561935719358193591936019361193621936319364193651936619367193681936919370193711937219373193741937519376193771937819379193801938119382193831938419385193861938719388193891939019391193921939319394193951939619397193981939919400194011940219403194041940519406194071940819409194101941119412194131941419415194161941719418194191942019421194221942319424194251942619427194281942919430194311943219433194341943519436194371943819439194401944119442194431944419445194461944719448194491945019451194521945319454194551945619457194581945919460194611946219463194641946519466194671946819469194701947119472194731947419475194761947719478194791948019481194821948319484194851948619487194881948919490194911949219493194941949519496194971949819499195001950119502195031950419505195061950719508195091951019511195121951319514195151951619517195181951919520195211952219523195241952519526195271952819529195301953119532195331953419535195361953719538195391954019541195421954319544195451954619547195481954919550195511955219553195541955519556195571955819559195601956119562195631956419565195661956719568195691957019571195721957319574195751957619577195781957919580195811958219583195841958519586195871958819589195901959119592195931959419595195961959719598195991960019601196021960319604196051960619607196081960919610196111961219613196141961519616196171961819619196201962119622196231962419625196261962719628196291963019631196321963319634196351963619637196381963919640196411964219643196441964519646196471964819649196501965119652196531965419655196561965719658196591966019661196621966319664196651966619667196681966919670196711967219673196741967519676196771967819679196801968119682196831968419685196861968719688196891969019691196921969319694196951969619697196981969919700197011970219703197041970519706197071970819709197101971119712197131971419715197161971719718197191972019721197221972319724197251972619727197281972919730197311973219733197341973519736197371973819739197401974119742197431974419745197461974719748197491975019751197521975319754197551975619757197581975919760197611976219763197641976519766197671976819769197701977119772197731977419775197761977719778197791978019781197821978319784197851978619787197881978919790197911979219793197941979519796197971979819799198001980119802198031980419805198061980719808198091981019811198121981319814198151981619817198181981919820198211982219823198241982519826198271982819829198301983119832198331983419835198361983719838198391984019841198421984319844198451984619847198481984919850198511985219853198541985519856198571985819859198601986119862198631986419865198661986719868198691987019871198721987319874198751987619877198781987919880198811988219883198841988519886198871988819889198901989119892198931989419895198961989719898198991990019901199021990319904199051990619907199081990919910199111991219913199141991519916199171991819919199201992119922199231992419925199261992719928199291993019931199321993319934199351993619937199381993919940199411994219943199441994519946199471994819949199501995119952199531995419955199561995719958199591996019961199621996319964199651996619967199681996919970199711997219973199741997519976199771997819979199801998119982199831998419985199861998719988199891999019991199921999319994199951999619997199981999920000200012000220003200042000520006200072000820009200102001120012200132001420015200162001720018200192002020021200222002320024200252002620027200282002920030200312003220033200342003520036200372003820039200402004120042200432004420045200462004720048200492005020051200522005320054200552005620057200582005920060200612006220063200642006520066200672006820069200702007120072200732007420075200762007720078200792008020081200822008320084200852008620087200882008920090200912009220093200942009520096200972009820099201002010120102201032010420105201062010720108201092011020111201122011320114201152011620117201182011920120201212012220123201242012520126201272012820129201302013120132201332013420135201362013720138201392014020141201422014320144201452014620147201482014920150201512015220153201542015520156201572015820159201602016120162201632016420165201662016720168201692017020171201722017320174201752017620177201782017920180201812018220183201842018520186201872018820189201902019120192201932019420195201962019720198201992020020201202022020320204202052020620207202082020920210202112021220213202142021520216202172021820219202202022120222202232022420225202262022720228202292023020231202322023320234202352023620237202382023920240202412024220243202442024520246202472024820249202502025120252202532025420255202562025720258202592026020261202622026320264202652026620267202682026920270202712027220273202742027520276202772027820279202802028120282202832028420285202862028720288202892029020291202922029320294202952029620297202982029920300203012030220303203042030520306203072030820309203102031120312203132031420315203162031720318203192032020321203222032320324203252032620327203282032920330203312033220333203342033520336203372033820339203402034120342203432034420345203462034720348203492035020351203522035320354203552035620357203582035920360203612036220363203642036520366203672036820369203702037120372203732037420375203762037720378203792038020381203822038320384203852038620387203882038920390203912039220393203942039520396203972039820399204002040120402204032040420405204062040720408204092041020411204122041320414204152041620417204182041920420204212042220423204242042520426204272042820429204302043120432204332043420435204362043720438204392044020441204422044320444204452044620447204482044920450204512045220453204542045520456204572045820459204602046120462204632046420465204662046720468204692047020471204722047320474204752047620477204782047920480204812048220483204842048520486204872048820489204902049120492204932049420495204962049720498204992050020501205022050320504205052050620507205082050920510205112051220513205142051520516205172051820519205202052120522205232052420525205262052720528205292053020531205322053320534205352053620537205382053920540205412054220543205442054520546205472054820549205502055120552205532055420555205562055720558205592056020561205622056320564205652056620567205682056920570205712057220573205742057520576205772057820579205802058120582205832058420585205862058720588205892059020591205922059320594205952059620597205982059920600206012060220603206042060520606206072060820609206102061120612206132061420615206162061720618206192062020621206222062320624206252062620627206282062920630206312063220633206342063520636206372063820639206402064120642206432064420645206462064720648206492065020651206522065320654206552065620657206582065920660206612066220663206642066520666206672066820669206702067120672206732067420675206762067720678206792068020681206822068320684206852068620687206882068920690206912069220693206942069520696206972069820699207002070120702207032070420705207062070720708207092071020711207122071320714207152071620717207182071920720207212072220723207242072520726207272072820729207302073120732207332073420735207362073720738207392074020741207422074320744207452074620747207482074920750207512075220753207542075520756207572075820759207602076120762207632076420765207662076720768207692077020771207722077320774207752077620777207782077920780207812078220783207842078520786207872078820789207902079120792207932079420795207962079720798207992080020801208022080320804208052080620807208082080920810208112081220813208142081520816208172081820819208202082120822208232082420825208262082720828208292083020831208322083320834208352083620837208382083920840208412084220843208442084520846208472084820849208502085120852208532085420855208562085720858208592086020861208622086320864208652086620867208682086920870208712087220873208742087520876208772087820879208802088120882208832088420885208862088720888208892089020891208922089320894208952089620897208982089920900209012090220903209042090520906209072090820909209102091120912209132091420915209162091720918209192092020921209222092320924209252092620927209282092920930209312093220933209342093520936209372093820939209402094120942209432094420945209462094720948209492095020951209522095320954209552095620957209582095920960209612096220963209642096520966209672096820969209702097120972209732097420975209762097720978209792098020981209822098320984209852098620987209882098920990209912099220993209942099520996209972099820999210002100121002210032100421005210062100721008210092101021011210122101321014210152101621017210182101921020210212102221023210242102521026210272102821029210302103121032
  1. <?xml version="1.0" encoding="iso-8859-1" standalone="no"?>
  2. <!-- Generated by the JDiff Javadoc doclet -->
  3. <!-- (http://www.jdiff.org) -->
  4. <!-- on Sun May 31 20:42:50 PDT 2009 -->
  5. <api
  6. xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
  7. xsi:noNamespaceSchemaLocation='api.xsd'
  8. name="hadoopp-mapred 0.20.0"
  9. jdversion="1.0.9">
  10. <!-- Command line arguments = -doclet jdiff.JDiff -docletpath /home/gkesavan/release-0.20.0/build/ivy/lib/Hadoop/jdiff/jdiff-1.0.9.jar:/home/gkesavan/release-0.20.0/build/ivy/lib/Hadoop/jdiff/xerces-1.4.4.jar -classpath /home/gkesavan/release-0.20.0/build/classes:/home/gkesavan/release-0.20.0/lib/commons-cli-2.0-SNAPSHOT.jar:/home/gkesavan/release-0.20.0/lib/hsqldb-1.8.0.10.jar:/home/gkesavan/release-0.20.0/lib/jsp-2.1/jsp-2.1.jar:/home/gkesavan/release-0.20.0/lib/jsp-2.1/jsp-api-2.1.jar:/home/gkesavan/release-0.20.0/lib/kfs-0.2.2.jar:/home/gkesavan/release-0.20.0/conf:/home/gkesavan/.ivy2/cache/commons-logging/commons-logging/jars/commons-logging-1.0.4.jar:/home/gkesavan/.ivy2/cache/log4j/log4j/jars/log4j-1.2.15.jar:/home/gkesavan/.ivy2/cache/commons-httpclient/commons-httpclient/jars/commons-httpclient-3.0.1.jar:/home/gkesavan/.ivy2/cache/commons-codec/commons-codec/jars/commons-codec-1.3.jar:/home/gkesavan/.ivy2/cache/xmlenc/xmlenc/jars/xmlenc-0.52.jar:/home/gkesavan/.ivy2/cache/net.java.dev.jets3t/jets3t/jars/jets3t-0.6.1.jar:/home/gkesavan/.ivy2/cache/commons-net/commons-net/jars/commons-net-1.4.1.jar:/home/gkesavan/.ivy2/cache/org.mortbay.jetty/servlet-api-2.5/jars/servlet-api-2.5-6.1.14.jar:/home/gkesavan/.ivy2/cache/oro/oro/jars/oro-2.0.8.jar:/home/gkesavan/.ivy2/cache/org.mortbay.jetty/jetty/jars/jetty-6.1.14.jar:/home/gkesavan/.ivy2/cache/org.mortbay.jetty/jetty-util/jars/jetty-util-6.1.14.jar:/home/gkesavan/.ivy2/cache/tomcat/jasper-runtime/jars/jasper-runtime-5.5.12.jar:/home/gkesavan/.ivy2/cache/tomcat/jasper-compiler/jars/jasper-compiler-5.5.12.jar:/home/gkesavan/.ivy2/cache/commons-el/commons-el/jars/commons-el-1.0.jar:/home/gkesavan/.ivy2/cache/junit/junit/jars/junit-3.8.1.jar:/home/gkesavan/.ivy2/cache/commons-logging/commons-logging-api/jars/commons-logging-api-1.0.4.jar:/home/gkesavan/.ivy2/cache/org.slf4j/slf4j-api/jars/slf4j-api-1.4.3.jar:/home/gkesavan/.ivy2/cache/org.eclipse.jdt/core/jars/core-3.1.1.jar:/home/gkesavan/.ivy2/cache/org.slf4j/slf4j-log4j12/jars/slf4j-log4j12-1.4.3.jar:/home/gkesavan/.ivy2/cache/jdiff/jdiff/jars/jdiff-1.0.9.jar:/home/gkesavan/.ivy2/cache/xerces/xerces/jars/xerces-1.4.4.jar:/home/gkesavan/tools/apache-ant-1.7.1/lib/ant-launcher.jar:/home/gkesavan/tools/apache-ant-1.7.1/lib/ant-apache-resolver.jar:/home/gkesavan/tools/apache-ant-1.7.1/lib/ant-starteam.jar:/home/gkesavan/tools/apache-ant-1.7.1/lib/ant-netrexx.jar:/home/gkesavan/tools/apache-ant-1.7.1/lib/ant-testutil.jar:/home/gkesavan/tools/apache-ant-1.7.1/lib/ant-jai.jar:/home/gkesavan/tools/apache-ant-1.7.1/lib/ant-swing.jar:/home/gkesavan/tools/apache-ant-1.7.1/lib/ant-jmf.jar:/home/gkesavan/tools/apache-ant-1.7.1/lib/ant-apache-bcel.jar:/home/gkesavan/tools/apache-ant-1.7.1/lib/ant-jdepend.jar:/home/gkesavan/tools/apache-ant-1.7.1/lib/ant-jsch.jar:/home/gkesavan/tools/apache-ant-1.7.1/lib/ant-apache-bsf.jar:/home/gkesavan/tools/apache-ant-1.7.1/lib/ant-antlr.jar:/home/gkesavan/tools/apache-ant-1.7.1/lib/ant-weblogic.jar:/home/gkesavan/tools/apache-ant-1.7.1/lib/ant-junit.jar:/home/gkesavan/tools/apache-ant-1.7.1/lib/ant-apache-log4j.jar:/home/gkesavan/tools/apache-ant-1.7.1/lib/xercesImpl.jar:/home/gkesavan/tools/apache-ant-1.7.1/lib/ant-apache-oro.jar:/home/gkesavan/tools/apache-ant-1.7.1/lib/ant.jar:/home/gkesavan/tools/apache-ant-1.7.1/lib/ant-trax.jar:/home/gkesavan/tools/apache-ant-1.7.1/lib/ant-nodeps.jar:/home/gkesavan/tools/apache-ant-1.7.1/lib/ant-commons-logging.jar:/home/gkesavan/tools/apache-ant-1.7.1/lib/ant-apache-regexp.jar:/home/gkesavan/tools/apache-ant-1.7.1/lib/ant-stylebook.jar:/home/gkesavan/tools/apache-ant-1.7.1/lib/ant-javamail.jar:/home/gkesavan/tools/apache-ant-1.7.1/lib/ant-commons-net.jar:/home/gkesavan/tools/apache-ant-1.7.1/lib/xml-apis.jar:/home/gkesavan/tools/jdk1.6.0_07-32bit/lib/tools.jar -sourcepath /home/gkesavan/release-0.20.0/src/mapred:/home/gkesavan/release-0.20.0/src/tools -apidir /home/gkesavan/release-0.20.0/lib/jdiff -apiname hadoop-mapred 0.20.0 -->
  11. <package name="org.apache.hadoop.mapred">
  12. <!-- start class org.apache.hadoop.mapred.ClusterStatus -->
  13. <class name="ClusterStatus" extends="java.lang.Object"
  14. abstract="false"
  15. static="false" final="false" visibility="public"
  16. deprecated="not deprecated">
  17. <implements name="org.apache.hadoop.io.Writable"/>
  18. <method name="getTaskTrackers" return="int"
  19. abstract="false" native="false" synchronized="false"
  20. static="false" final="false" visibility="public"
  21. deprecated="not deprecated">
  22. <doc>
  23. <![CDATA[Get the number of task trackers in the cluster.
  24. @return the number of task trackers in the cluster.]]>
  25. </doc>
  26. </method>
  27. <method name="getActiveTrackerNames" return="java.util.Collection"
  28. abstract="false" native="false" synchronized="false"
  29. static="false" final="false" visibility="public"
  30. deprecated="not deprecated">
  31. <doc>
  32. <![CDATA[Get the names of task trackers in the cluster.
  33. @return the active task trackers in the cluster.]]>
  34. </doc>
  35. </method>
  36. <method name="getBlacklistedTrackerNames" return="java.util.Collection"
  37. abstract="false" native="false" synchronized="false"
  38. static="false" final="false" visibility="public"
  39. deprecated="not deprecated">
  40. <doc>
  41. <![CDATA[Get the names of task trackers in the cluster.
  42. @return the blacklisted task trackers in the cluster.]]>
  43. </doc>
  44. </method>
  45. <method name="getBlacklistedTrackers" return="int"
  46. abstract="false" native="false" synchronized="false"
  47. static="false" final="false" visibility="public"
  48. deprecated="not deprecated">
  49. <doc>
  50. <![CDATA[Get the number of blacklisted task trackers in the cluster.
  51. @return the number of blacklisted task trackers in the cluster.]]>
  52. </doc>
  53. </method>
  54. <method name="getTTExpiryInterval" return="long"
  55. abstract="false" native="false" synchronized="false"
  56. static="false" final="false" visibility="public"
  57. deprecated="not deprecated">
  58. <doc>
  59. <![CDATA[Get the tasktracker expiry interval for the cluster
  60. @return the expiry interval in msec]]>
  61. </doc>
  62. </method>
  63. <method name="getMapTasks" return="int"
  64. abstract="false" native="false" synchronized="false"
  65. static="false" final="false" visibility="public"
  66. deprecated="not deprecated">
  67. <doc>
  68. <![CDATA[Get the number of currently running map tasks in the cluster.
  69. @return the number of currently running map tasks in the cluster.]]>
  70. </doc>
  71. </method>
  72. <method name="getReduceTasks" return="int"
  73. abstract="false" native="false" synchronized="false"
  74. static="false" final="false" visibility="public"
  75. deprecated="not deprecated">
  76. <doc>
  77. <![CDATA[Get the number of currently running reduce tasks in the cluster.
  78. @return the number of currently running reduce tasks in the cluster.]]>
  79. </doc>
  80. </method>
  81. <method name="getMaxMapTasks" return="int"
  82. abstract="false" native="false" synchronized="false"
  83. static="false" final="false" visibility="public"
  84. deprecated="not deprecated">
  85. <doc>
  86. <![CDATA[Get the maximum capacity for running map tasks in the cluster.
  87. @return the maximum capacity for running map tasks in the cluster.]]>
  88. </doc>
  89. </method>
  90. <method name="getMaxReduceTasks" return="int"
  91. abstract="false" native="false" synchronized="false"
  92. static="false" final="false" visibility="public"
  93. deprecated="not deprecated">
  94. <doc>
  95. <![CDATA[Get the maximum capacity for running reduce tasks in the cluster.
  96. @return the maximum capacity for running reduce tasks in the cluster.]]>
  97. </doc>
  98. </method>
  99. <method name="getJobTrackerState" return="org.apache.hadoop.mapred.JobTracker.State"
  100. abstract="false" native="false" synchronized="false"
  101. static="false" final="false" visibility="public"
  102. deprecated="not deprecated">
  103. <doc>
  104. <![CDATA[Get the current state of the <code>JobTracker</code>,
  105. as {@link JobTracker.State}
  106. @return the current state of the <code>JobTracker</code>.]]>
  107. </doc>
  108. </method>
  109. <method name="getUsedMemory" return="long"
  110. abstract="false" native="false" synchronized="false"
  111. static="false" final="false" visibility="public"
  112. deprecated="not deprecated">
  113. <doc>
  114. <![CDATA[Get the total heap memory used by the <code>JobTracker</code>
  115. @return the size of heap memory used by the <code>JobTracker</code>]]>
  116. </doc>
  117. </method>
  118. <method name="getMaxMemory" return="long"
  119. abstract="false" native="false" synchronized="false"
  120. static="false" final="false" visibility="public"
  121. deprecated="not deprecated">
  122. <doc>
  123. <![CDATA[Get the maximum configured heap memory that can be used by the <code>JobTracker</code>
  124. @return the configured size of max heap memory that can be used by the <code>JobTracker</code>]]>
  125. </doc>
  126. </method>
  127. <method name="write"
  128. abstract="false" native="false" synchronized="false"
  129. static="false" final="false" visibility="public"
  130. deprecated="not deprecated">
  131. <param name="out" type="java.io.DataOutput"/>
  132. <exception name="IOException" type="java.io.IOException"/>
  133. </method>
  134. <method name="readFields"
  135. abstract="false" native="false" synchronized="false"
  136. static="false" final="false" visibility="public"
  137. deprecated="not deprecated">
  138. <param name="in" type="java.io.DataInput"/>
  139. <exception name="IOException" type="java.io.IOException"/>
  140. </method>
  141. <doc>
  142. <![CDATA[Status information on the current state of the Map-Reduce cluster.
  143. <p><code>ClusterStatus</code> provides clients with information such as:
  144. <ol>
  145. <li>
  146. Size of the cluster.
  147. </li>
  148. <li>
  149. Name of the trackers.
  150. </li>
  151. <li>
  152. Task capacity of the cluster.
  153. </li>
  154. <li>
  155. The number of currently running map & reduce tasks.
  156. </li>
  157. <li>
  158. State of the <code>JobTracker</code>.
  159. </li>
  160. </ol></p>
  161. <p>Clients can query for the latest <code>ClusterStatus</code>, via
  162. {@link JobClient#getClusterStatus()}.</p>
  163. @see JobClient]]>
  164. </doc>
  165. </class>
  166. <!-- end class org.apache.hadoop.mapred.ClusterStatus -->
  167. <!-- start class org.apache.hadoop.mapred.Counters -->
  168. <class name="Counters" extends="java.lang.Object"
  169. abstract="false"
  170. static="false" final="false" visibility="public"
  171. deprecated="Use {@link org.apache.hadoop.mapreduce.Counters} instead.">
  172. <implements name="org.apache.hadoop.io.Writable"/>
  173. <implements name="java.lang.Iterable"/>
  174. <constructor name="Counters"
  175. static="false" final="false" visibility="public"
  176. deprecated="not deprecated">
  177. </constructor>
  178. <method name="getGroupNames" return="java.util.Collection"
  179. abstract="false" native="false" synchronized="true"
  180. static="false" final="false" visibility="public"
  181. deprecated="not deprecated">
  182. <doc>
  183. <![CDATA[Returns the names of all counter classes.
  184. @return Set of counter names.]]>
  185. </doc>
  186. </method>
  187. <method name="iterator" return="java.util.Iterator"
  188. abstract="false" native="false" synchronized="true"
  189. static="false" final="false" visibility="public"
  190. deprecated="not deprecated">
  191. </method>
  192. <method name="getGroup" return="org.apache.hadoop.mapred.Counters.Group"
  193. abstract="false" native="false" synchronized="true"
  194. static="false" final="false" visibility="public"
  195. deprecated="not deprecated">
  196. <param name="groupName" type="java.lang.String"/>
  197. <doc>
  198. <![CDATA[Returns the named counter group, or an empty group if there is none
  199. with the specified name.]]>
  200. </doc>
  201. </method>
  202. <method name="findCounter" return="org.apache.hadoop.mapred.Counters.Counter"
  203. abstract="false" native="false" synchronized="true"
  204. static="false" final="false" visibility="public"
  205. deprecated="not deprecated">
  206. <param name="key" type="java.lang.Enum"/>
  207. <doc>
  208. <![CDATA[Find the counter for the given enum. The same enum will always return the
  209. same counter.
  210. @param key the counter key
  211. @return the matching counter object]]>
  212. </doc>
  213. </method>
  214. <method name="findCounter" return="org.apache.hadoop.mapred.Counters.Counter"
  215. abstract="false" native="false" synchronized="true"
  216. static="false" final="false" visibility="public"
  217. deprecated="not deprecated">
  218. <param name="group" type="java.lang.String"/>
  219. <param name="name" type="java.lang.String"/>
  220. <doc>
  221. <![CDATA[Find a counter given the group and the name.
  222. @param group the name of the group
  223. @param name the internal name of the counter
  224. @return the counter for that name]]>
  225. </doc>
  226. </method>
  227. <method name="findCounter" return="org.apache.hadoop.mapred.Counters.Counter"
  228. abstract="false" native="false" synchronized="true"
  229. static="false" final="false" visibility="public"
  230. deprecated="deprecated, no comment">
  231. <param name="group" type="java.lang.String"/>
  232. <param name="id" type="int"/>
  233. <param name="name" type="java.lang.String"/>
  234. <doc>
  235. <![CDATA[Find a counter by using strings
  236. @param group the name of the group
  237. @param id the id of the counter within the group (0 to N-1)
  238. @param name the internal name of the counter
  239. @return the counter for that name
  240. @deprecated]]>
  241. </doc>
  242. </method>
  243. <method name="incrCounter"
  244. abstract="false" native="false" synchronized="true"
  245. static="false" final="false" visibility="public"
  246. deprecated="not deprecated">
  247. <param name="key" type="java.lang.Enum"/>
  248. <param name="amount" type="long"/>
  249. <doc>
  250. <![CDATA[Increments the specified counter by the specified amount, creating it if
  251. it didn't already exist.
  252. @param key identifies a counter
  253. @param amount amount by which counter is to be incremented]]>
  254. </doc>
  255. </method>
  256. <method name="incrCounter"
  257. abstract="false" native="false" synchronized="true"
  258. static="false" final="false" visibility="public"
  259. deprecated="not deprecated">
  260. <param name="group" type="java.lang.String"/>
  261. <param name="counter" type="java.lang.String"/>
  262. <param name="amount" type="long"/>
  263. <doc>
  264. <![CDATA[Increments the specified counter by the specified amount, creating it if
  265. it didn't already exist.
  266. @param group the name of the group
  267. @param counter the internal name of the counter
  268. @param amount amount by which counter is to be incremented]]>
  269. </doc>
  270. </method>
  271. <method name="getCounter" return="long"
  272. abstract="false" native="false" synchronized="true"
  273. static="false" final="false" visibility="public"
  274. deprecated="not deprecated">
  275. <param name="key" type="java.lang.Enum"/>
  276. <doc>
  277. <![CDATA[Returns current value of the specified counter, or 0 if the counter
  278. does not exist.]]>
  279. </doc>
  280. </method>
  281. <method name="incrAllCounters"
  282. abstract="false" native="false" synchronized="true"
  283. static="false" final="false" visibility="public"
  284. deprecated="not deprecated">
  285. <param name="other" type="org.apache.hadoop.mapred.Counters"/>
  286. <doc>
  287. <![CDATA[Increments multiple counters by their amounts in another Counters
  288. instance.
  289. @param other the other Counters instance]]>
  290. </doc>
  291. </method>
  292. <method name="sum" return="org.apache.hadoop.mapred.Counters"
  293. abstract="false" native="false" synchronized="false"
  294. static="true" final="false" visibility="public"
  295. deprecated="not deprecated">
  296. <param name="a" type="org.apache.hadoop.mapred.Counters"/>
  297. <param name="b" type="org.apache.hadoop.mapred.Counters"/>
  298. <doc>
  299. <![CDATA[Convenience method for computing the sum of two sets of counters.]]>
  300. </doc>
  301. </method>
  302. <method name="size" return="int"
  303. abstract="false" native="false" synchronized="true"
  304. static="false" final="false" visibility="public"
  305. deprecated="not deprecated">
  306. <doc>
  307. <![CDATA[Returns the total number of counters, by summing the number of counters
  308. in each group.]]>
  309. </doc>
  310. </method>
  311. <method name="write"
  312. abstract="false" native="false" synchronized="true"
  313. static="false" final="false" visibility="public"
  314. deprecated="not deprecated">
  315. <param name="out" type="java.io.DataOutput"/>
  316. <exception name="IOException" type="java.io.IOException"/>
  317. <doc>
  318. <![CDATA[Write the set of groups.
  319. The external format is:
  320. #groups (groupName group)*
  321. i.e. the number of groups followed by 0 or more groups, where each
  322. group is of the form:
  323. groupDisplayName #counters (false | true counter)*
  324. where each counter is of the form:
  325. name (false | true displayName) value]]>
  326. </doc>
  327. </method>
  328. <method name="readFields"
  329. abstract="false" native="false" synchronized="true"
  330. static="false" final="false" visibility="public"
  331. deprecated="not deprecated">
  332. <param name="in" type="java.io.DataInput"/>
  333. <exception name="IOException" type="java.io.IOException"/>
  334. <doc>
  335. <![CDATA[Read a set of groups.]]>
  336. </doc>
  337. </method>
  338. <method name="log"
  339. abstract="false" native="false" synchronized="false"
  340. static="false" final="false" visibility="public"
  341. deprecated="not deprecated">
  342. <param name="log" type="org.apache.commons.logging.Log"/>
  343. <doc>
  344. <![CDATA[Logs the current counter values.
  345. @param log The log to use.]]>
  346. </doc>
  347. </method>
  348. <method name="toString" return="java.lang.String"
  349. abstract="false" native="false" synchronized="true"
  350. static="false" final="false" visibility="public"
  351. deprecated="not deprecated">
  352. <doc>
  353. <![CDATA[Return textual representation of the counter values.]]>
  354. </doc>
  355. </method>
  356. <method name="makeCompactString" return="java.lang.String"
  357. abstract="false" native="false" synchronized="true"
  358. static="false" final="false" visibility="public"
  359. deprecated="not deprecated">
  360. <doc>
  361. <![CDATA[Convert a counters object into a single line that is easy to parse.
  362. @return the string with "name=value" for each counter and separated by ","]]>
  363. </doc>
  364. </method>
  365. <method name="makeEscapedCompactString" return="java.lang.String"
  366. abstract="false" native="false" synchronized="true"
  367. static="false" final="false" visibility="public"
  368. deprecated="not deprecated">
  369. <doc>
  370. <![CDATA[Represent the counter in a textual format that can be converted back to
  371. its object form
  372. @return the string in the following format
  373. {(groupname)(group-displayname)[(countername)(displayname)(value)][][]}{}{}]]>
  374. </doc>
  375. </method>
  376. <method name="fromEscapedCompactString" return="org.apache.hadoop.mapred.Counters"
  377. abstract="false" native="false" synchronized="false"
  378. static="true" final="false" visibility="public"
  379. deprecated="not deprecated">
  380. <param name="compactString" type="java.lang.String"/>
  381. <exception name="ParseException" type="java.text.ParseException"/>
  382. <doc>
  383. <![CDATA[Convert a stringified counter representation into a counter object. Note
  384. that the counter can be recovered if its stringified using
  385. {@link #makeEscapedCompactString()}.
  386. @return a Counter]]>
  387. </doc>
  388. </method>
  389. <method name="hashCode" return="int"
  390. abstract="false" native="false" synchronized="true"
  391. static="false" final="false" visibility="public"
  392. deprecated="not deprecated">
  393. </method>
  394. <method name="equals" return="boolean"
  395. abstract="false" native="false" synchronized="true"
  396. static="false" final="false" visibility="public"
  397. deprecated="not deprecated">
  398. <param name="obj" type="java.lang.Object"/>
  399. </method>
  400. <doc>
  401. <![CDATA[A set of named counters.
  402. <p><code>Counters</code> represent global counters, defined either by the
  403. Map-Reduce framework or applications. Each <code>Counter</code> can be of
  404. any {@link Enum} type.</p>
  405. <p><code>Counters</code> are bunched into {@link Group}s, each comprising of
  406. counters from a particular <code>Enum</code> class.
  407. @deprecated Use {@link org.apache.hadoop.mapreduce.Counters} instead.]]>
  408. </doc>
  409. </class>
  410. <!-- end class org.apache.hadoop.mapred.Counters -->
  411. <!-- start class org.apache.hadoop.mapred.Counters.Counter -->
  412. <class name="Counters.Counter" extends="org.apache.hadoop.mapreduce.Counter"
  413. abstract="false"
  414. static="true" final="false" visibility="public"
  415. deprecated="not deprecated">
  416. <method name="setDisplayName"
  417. abstract="false" native="false" synchronized="false"
  418. static="false" final="false" visibility="public"
  419. deprecated="not deprecated">
  420. <param name="newName" type="java.lang.String"/>
  421. </method>
  422. <method name="makeEscapedCompactString" return="java.lang.String"
  423. abstract="false" native="false" synchronized="true"
  424. static="false" final="false" visibility="public"
  425. deprecated="not deprecated">
  426. <doc>
  427. <![CDATA[Returns the compact stringified version of the counter in the format
  428. [(actual-name)(display-name)(value)]]]>
  429. </doc>
  430. </method>
  431. <method name="getCounter" return="long"
  432. abstract="false" native="false" synchronized="true"
  433. static="false" final="false" visibility="public"
  434. deprecated="not deprecated">
  435. <doc>
  436. <![CDATA[What is the current value of this counter?
  437. @return the current value]]>
  438. </doc>
  439. </method>
  440. <doc>
  441. <![CDATA[A counter record, comprising its name and value.]]>
  442. </doc>
  443. </class>
  444. <!-- end class org.apache.hadoop.mapred.Counters.Counter -->
  445. <!-- start class org.apache.hadoop.mapred.Counters.Group -->
  446. <class name="Counters.Group" extends="java.lang.Object"
  447. abstract="false"
  448. static="true" final="false" visibility="public"
  449. deprecated="not deprecated">
  450. <implements name="org.apache.hadoop.io.Writable"/>
  451. <implements name="java.lang.Iterable"/>
  452. <method name="getName" return="java.lang.String"
  453. abstract="false" native="false" synchronized="false"
  454. static="false" final="false" visibility="public"
  455. deprecated="not deprecated">
  456. <doc>
  457. <![CDATA[Returns raw name of the group. This is the name of the enum class
  458. for this group of counters.]]>
  459. </doc>
  460. </method>
  461. <method name="getDisplayName" return="java.lang.String"
  462. abstract="false" native="false" synchronized="false"
  463. static="false" final="false" visibility="public"
  464. deprecated="not deprecated">
  465. <doc>
  466. <![CDATA[Returns localized name of the group. This is the same as getName() by
  467. default, but different if an appropriate ResourceBundle is found.]]>
  468. </doc>
  469. </method>
  470. <method name="setDisplayName"
  471. abstract="false" native="false" synchronized="false"
  472. static="false" final="false" visibility="public"
  473. deprecated="not deprecated">
  474. <param name="displayName" type="java.lang.String"/>
  475. <doc>
  476. <![CDATA[Set the display name]]>
  477. </doc>
  478. </method>
  479. <method name="makeEscapedCompactString" return="java.lang.String"
  480. abstract="false" native="false" synchronized="false"
  481. static="false" final="false" visibility="public"
  482. deprecated="not deprecated">
  483. <doc>
  484. <![CDATA[Returns the compact stringified version of the group in the format
  485. {(actual-name)(display-name)(value)[][][]} where [] are compact strings for the
  486. counters within.]]>
  487. </doc>
  488. </method>
  489. <method name="hashCode" return="int"
  490. abstract="false" native="false" synchronized="false"
  491. static="false" final="false" visibility="public"
  492. deprecated="not deprecated">
  493. </method>
  494. <method name="equals" return="boolean"
  495. abstract="false" native="false" synchronized="true"
  496. static="false" final="false" visibility="public"
  497. deprecated="not deprecated">
  498. <param name="obj" type="java.lang.Object"/>
  499. <doc>
  500. <![CDATA[Checks for (content) equality of Groups]]>
  501. </doc>
  502. </method>
  503. <method name="getCounter" return="long"
  504. abstract="false" native="false" synchronized="true"
  505. static="false" final="false" visibility="public"
  506. deprecated="not deprecated">
  507. <param name="counterName" type="java.lang.String"/>
  508. <doc>
  509. <![CDATA[Returns the value of the specified counter, or 0 if the counter does
  510. not exist.]]>
  511. </doc>
  512. </method>
  513. <method name="getCounter" return="org.apache.hadoop.mapred.Counters.Counter"
  514. abstract="false" native="false" synchronized="true"
  515. static="false" final="false" visibility="public"
  516. deprecated="use {@link #getCounter(String)} instead">
  517. <param name="id" type="int"/>
  518. <param name="name" type="java.lang.String"/>
  519. <doc>
  520. <![CDATA[Get the counter for the given id and create it if it doesn't exist.
  521. @param id the numeric id of the counter within the group
  522. @param name the internal counter name
  523. @return the counter
  524. @deprecated use {@link #getCounter(String)} instead]]>
  525. </doc>
  526. </method>
  527. <method name="getCounterForName" return="org.apache.hadoop.mapred.Counters.Counter"
  528. abstract="false" native="false" synchronized="true"
  529. static="false" final="false" visibility="public"
  530. deprecated="not deprecated">
  531. <param name="name" type="java.lang.String"/>
  532. <doc>
  533. <![CDATA[Get the counter for the given name and create it if it doesn't exist.
  534. @param name the internal counter name
  535. @return the counter]]>
  536. </doc>
  537. </method>
  538. <method name="size" return="int"
  539. abstract="false" native="false" synchronized="true"
  540. static="false" final="false" visibility="public"
  541. deprecated="not deprecated">
  542. <doc>
  543. <![CDATA[Returns the number of counters in this group.]]>
  544. </doc>
  545. </method>
  546. <method name="write"
  547. abstract="false" native="false" synchronized="true"
  548. static="false" final="false" visibility="public"
  549. deprecated="not deprecated">
  550. <param name="out" type="java.io.DataOutput"/>
  551. <exception name="IOException" type="java.io.IOException"/>
  552. </method>
  553. <method name="readFields"
  554. abstract="false" native="false" synchronized="true"
  555. static="false" final="false" visibility="public"
  556. deprecated="not deprecated">
  557. <param name="in" type="java.io.DataInput"/>
  558. <exception name="IOException" type="java.io.IOException"/>
  559. </method>
  560. <method name="iterator" return="java.util.Iterator"
  561. abstract="false" native="false" synchronized="true"
  562. static="false" final="false" visibility="public"
  563. deprecated="not deprecated">
  564. </method>
  565. <doc>
  566. <![CDATA[<code>Group</code> of counters, comprising of counters from a particular
  567. counter {@link Enum} class.
  568. <p><code>Group</code>handles localization of the class name and the
  569. counter names.</p>]]>
  570. </doc>
  571. </class>
  572. <!-- end class org.apache.hadoop.mapred.Counters.Group -->
  573. <!-- start class org.apache.hadoop.mapred.DefaultJobHistoryParser -->
  574. <class name="DefaultJobHistoryParser" extends="java.lang.Object"
  575. abstract="false"
  576. static="false" final="false" visibility="public"
  577. deprecated="not deprecated">
  578. <constructor name="DefaultJobHistoryParser"
  579. static="false" final="false" visibility="public"
  580. deprecated="not deprecated">
  581. </constructor>
  582. <method name="parseJobTasks"
  583. abstract="false" native="false" synchronized="false"
  584. static="true" final="false" visibility="public"
  585. deprecated="not deprecated">
  586. <param name="jobHistoryFile" type="java.lang.String"/>
  587. <param name="job" type="org.apache.hadoop.mapred.JobHistory.JobInfo"/>
  588. <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
  589. <exception name="IOException" type="java.io.IOException"/>
  590. <doc>
  591. <![CDATA[Populates a JobInfo object from the job's history log file.
  592. @param jobHistoryFile history file for this job.
  593. @param job a precreated JobInfo object, should be non-null.
  594. @param fs FileSystem where historyFile is present.
  595. @throws IOException]]>
  596. </doc>
  597. </method>
  598. <doc>
  599. <![CDATA[Default parser for job history files. It creates object model from
  600. job history file.]]>
  601. </doc>
  602. </class>
  603. <!-- end class org.apache.hadoop.mapred.DefaultJobHistoryParser -->
  604. <!-- start class org.apache.hadoop.mapred.FileAlreadyExistsException -->
  605. <class name="FileAlreadyExistsException" extends="java.io.IOException"
  606. abstract="false"
  607. static="false" final="false" visibility="public"
  608. deprecated="not deprecated">
  609. <constructor name="FileAlreadyExistsException"
  610. static="false" final="false" visibility="public"
  611. deprecated="not deprecated">
  612. </constructor>
  613. <constructor name="FileAlreadyExistsException" type="java.lang.String"
  614. static="false" final="false" visibility="public"
  615. deprecated="not deprecated">
  616. </constructor>
  617. <doc>
  618. <![CDATA[Used when target file already exists for any operation and
  619. is not configured to be overwritten.]]>
  620. </doc>
  621. </class>
  622. <!-- end class org.apache.hadoop.mapred.FileAlreadyExistsException -->
  623. <!-- start class org.apache.hadoop.mapred.FileInputFormat -->
  624. <class name="FileInputFormat" extends="java.lang.Object"
  625. abstract="true"
  626. static="false" final="false" visibility="public"
  627. deprecated="Use {@link org.apache.hadoop.mapreduce.lib.input.FileInputFormat}
  628. instead.">
  629. <implements name="org.apache.hadoop.mapred.InputFormat"/>
  630. <constructor name="FileInputFormat"
  631. static="false" final="false" visibility="public"
  632. deprecated="not deprecated">
  633. </constructor>
  634. <method name="setMinSplitSize"
  635. abstract="false" native="false" synchronized="false"
  636. static="false" final="false" visibility="protected"
  637. deprecated="not deprecated">
  638. <param name="minSplitSize" type="long"/>
  639. </method>
  640. <method name="isSplitable" return="boolean"
  641. abstract="false" native="false" synchronized="false"
  642. static="false" final="false" visibility="protected"
  643. deprecated="not deprecated">
  644. <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
  645. <param name="filename" type="org.apache.hadoop.fs.Path"/>
  646. <doc>
  647. <![CDATA[Is the given filename splitable? Usually, true, but if the file is
  648. stream compressed, it will not be.
  649. <code>FileInputFormat</code> implementations can override this and return
  650. <code>false</code> to ensure that individual input files are never split-up
  651. so that {@link Mapper}s process entire files.
  652. @param fs the file system that the file is on
  653. @param filename the file name to check
  654. @return is this file splitable?]]>
  655. </doc>
  656. </method>
  657. <method name="getRecordReader" return="org.apache.hadoop.mapred.RecordReader"
  658. abstract="true" native="false" synchronized="false"
  659. static="false" final="false" visibility="public"
  660. deprecated="not deprecated">
  661. <param name="split" type="org.apache.hadoop.mapred.InputSplit"/>
  662. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  663. <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
  664. <exception name="IOException" type="java.io.IOException"/>
  665. </method>
  666. <method name="setInputPathFilter"
  667. abstract="false" native="false" synchronized="false"
  668. static="true" final="false" visibility="public"
  669. deprecated="not deprecated">
  670. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  671. <param name="filter" type="java.lang.Class"/>
  672. <doc>
  673. <![CDATA[Set a PathFilter to be applied to the input paths for the map-reduce job.
  674. @param filter the PathFilter class use for filtering the input paths.]]>
  675. </doc>
  676. </method>
  677. <method name="getInputPathFilter" return="org.apache.hadoop.fs.PathFilter"
  678. abstract="false" native="false" synchronized="false"
  679. static="true" final="false" visibility="public"
  680. deprecated="not deprecated">
  681. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  682. <doc>
  683. <![CDATA[Get a PathFilter instance of the filter set for the input paths.
  684. @return the PathFilter instance set for the job, NULL if none has been set.]]>
  685. </doc>
  686. </method>
  687. <method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
  688. abstract="false" native="false" synchronized="false"
  689. static="false" final="false" visibility="protected"
  690. deprecated="not deprecated">
  691. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  692. <exception name="IOException" type="java.io.IOException"/>
  693. <doc>
  694. <![CDATA[List input directories.
  695. Subclasses may override to, e.g., select only files matching a regular
  696. expression.
  697. @param job the job to list input paths for
  698. @return array of FileStatus objects
  699. @throws IOException if zero items.]]>
  700. </doc>
  701. </method>
  702. <method name="getSplits" return="org.apache.hadoop.mapred.InputSplit[]"
  703. abstract="false" native="false" synchronized="false"
  704. static="false" final="false" visibility="public"
  705. deprecated="not deprecated">
  706. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  707. <param name="numSplits" type="int"/>
  708. <exception name="IOException" type="java.io.IOException"/>
  709. <doc>
  710. <![CDATA[Splits files returned by {@link #listStatus(JobConf)} when
  711. they're too big.]]>
  712. </doc>
  713. </method>
  714. <method name="computeSplitSize" return="long"
  715. abstract="false" native="false" synchronized="false"
  716. static="false" final="false" visibility="protected"
  717. deprecated="not deprecated">
  718. <param name="goalSize" type="long"/>
  719. <param name="minSize" type="long"/>
  720. <param name="blockSize" type="long"/>
  721. </method>
  722. <method name="getBlockIndex" return="int"
  723. abstract="false" native="false" synchronized="false"
  724. static="false" final="false" visibility="protected"
  725. deprecated="not deprecated">
  726. <param name="blkLocations" type="org.apache.hadoop.fs.BlockLocation[]"/>
  727. <param name="offset" type="long"/>
  728. </method>
  729. <method name="setInputPaths"
  730. abstract="false" native="false" synchronized="false"
  731. static="true" final="false" visibility="public"
  732. deprecated="not deprecated">
  733. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  734. <param name="commaSeparatedPaths" type="java.lang.String"/>
  735. <doc>
  736. <![CDATA[Sets the given comma separated paths as the list of inputs
  737. for the map-reduce job.
  738. @param conf Configuration of the job
  739. @param commaSeparatedPaths Comma separated paths to be set as
  740. the list of inputs for the map-reduce job.]]>
  741. </doc>
  742. </method>
  743. <method name="addInputPaths"
  744. abstract="false" native="false" synchronized="false"
  745. static="true" final="false" visibility="public"
  746. deprecated="not deprecated">
  747. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  748. <param name="commaSeparatedPaths" type="java.lang.String"/>
  749. <doc>
  750. <![CDATA[Add the given comma separated paths to the list of inputs for
  751. the map-reduce job.
  752. @param conf The configuration of the job
  753. @param commaSeparatedPaths Comma separated paths to be added to
  754. the list of inputs for the map-reduce job.]]>
  755. </doc>
  756. </method>
  757. <method name="setInputPaths"
  758. abstract="false" native="false" synchronized="false"
  759. static="true" final="false" visibility="public"
  760. deprecated="not deprecated">
  761. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  762. <param name="inputPaths" type="org.apache.hadoop.fs.Path[]"/>
  763. <doc>
  764. <![CDATA[Set the array of {@link Path}s as the list of inputs
  765. for the map-reduce job.
  766. @param conf Configuration of the job.
  767. @param inputPaths the {@link Path}s of the input directories/files
  768. for the map-reduce job.]]>
  769. </doc>
  770. </method>
  771. <method name="addInputPath"
  772. abstract="false" native="false" synchronized="false"
  773. static="true" final="false" visibility="public"
  774. deprecated="not deprecated">
  775. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  776. <param name="path" type="org.apache.hadoop.fs.Path"/>
  777. <doc>
  778. <![CDATA[Add a {@link Path} to the list of inputs for the map-reduce job.
  779. @param conf The configuration of the job
  780. @param path {@link Path} to be added to the list of inputs for
  781. the map-reduce job.]]>
  782. </doc>
  783. </method>
  784. <method name="getInputPaths" return="org.apache.hadoop.fs.Path[]"
  785. abstract="false" native="false" synchronized="false"
  786. static="true" final="false" visibility="public"
  787. deprecated="not deprecated">
  788. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  789. <doc>
  790. <![CDATA[Get the list of input {@link Path}s for the map-reduce job.
  791. @param conf The configuration of the job
  792. @return the list of input {@link Path}s for the map-reduce job.]]>
  793. </doc>
  794. </method>
  795. <method name="getSplitHosts" return="java.lang.String[]"
  796. abstract="false" native="false" synchronized="false"
  797. static="false" final="false" visibility="protected"
  798. deprecated="not deprecated">
  799. <param name="blkLocations" type="org.apache.hadoop.fs.BlockLocation[]"/>
  800. <param name="offset" type="long"/>
  801. <param name="splitSize" type="long"/>
  802. <param name="clusterMap" type="org.apache.hadoop.net.NetworkTopology"/>
  803. <exception name="IOException" type="java.io.IOException"/>
  804. <doc>
  805. <![CDATA[This function identifies and returns the hosts that contribute
  806. most for a given split. For calculating the contribution, rack
  807. locality is treated on par with host locality, so hosts from racks
  808. that contribute the most are preferred over hosts on racks that
  809. contribute less
  810. @param blkLocations The list of block locations
  811. @param offset
  812. @param splitSize
  813. @return array of hosts that contribute most to this split
  814. @throws IOException]]>
  815. </doc>
  816. </method>
  817. <field name="LOG" type="org.apache.commons.logging.Log"
  818. transient="false" volatile="false"
  819. static="true" final="true" visibility="public"
  820. deprecated="not deprecated">
  821. </field>
  822. <doc>
  823. <![CDATA[A base class for file-based {@link InputFormat}.
  824. <p><code>FileInputFormat</code> is the base class for all file-based
  825. <code>InputFormat</code>s. This provides a generic implementation of
  826. {@link #getSplits(JobConf, int)}.
  827. Subclasses of <code>FileInputFormat</code> can also override the
  828. {@link #isSplitable(FileSystem, Path)} method to ensure input-files are
  829. not split-up and are processed as a whole by {@link Mapper}s.
  830. @deprecated Use {@link org.apache.hadoop.mapreduce.lib.input.FileInputFormat}
  831. instead.]]>
  832. </doc>
  833. </class>
  834. <!-- end class org.apache.hadoop.mapred.FileInputFormat -->
  835. <!-- start class org.apache.hadoop.mapred.FileOutputCommitter -->
  836. <class name="FileOutputCommitter" extends="org.apache.hadoop.mapred.OutputCommitter"
  837. abstract="false"
  838. static="false" final="false" visibility="public"
  839. deprecated="not deprecated">
  840. <constructor name="FileOutputCommitter"
  841. static="false" final="false" visibility="public"
  842. deprecated="not deprecated">
  843. </constructor>
  844. <method name="setupJob"
  845. abstract="false" native="false" synchronized="false"
  846. static="false" final="false" visibility="public"
  847. deprecated="not deprecated">
  848. <param name="context" type="org.apache.hadoop.mapred.JobContext"/>
  849. <exception name="IOException" type="java.io.IOException"/>
  850. </method>
  851. <method name="cleanupJob"
  852. abstract="false" native="false" synchronized="false"
  853. static="false" final="false" visibility="public"
  854. deprecated="not deprecated">
  855. <param name="context" type="org.apache.hadoop.mapred.JobContext"/>
  856. <exception name="IOException" type="java.io.IOException"/>
  857. </method>
  858. <method name="setupTask"
  859. abstract="false" native="false" synchronized="false"
  860. static="false" final="false" visibility="public"
  861. deprecated="not deprecated">
  862. <param name="context" type="org.apache.hadoop.mapred.TaskAttemptContext"/>
  863. <exception name="IOException" type="java.io.IOException"/>
  864. </method>
  865. <method name="commitTask"
  866. abstract="false" native="false" synchronized="false"
  867. static="false" final="false" visibility="public"
  868. deprecated="not deprecated">
  869. <param name="context" type="org.apache.hadoop.mapred.TaskAttemptContext"/>
  870. <exception name="IOException" type="java.io.IOException"/>
  871. </method>
  872. <method name="abortTask"
  873. abstract="false" native="false" synchronized="false"
  874. static="false" final="false" visibility="public"
  875. deprecated="not deprecated">
  876. <param name="context" type="org.apache.hadoop.mapred.TaskAttemptContext"/>
  877. <exception name="IOException" type="java.io.IOException"/>
  878. </method>
  879. <method name="needsTaskCommit" return="boolean"
  880. abstract="false" native="false" synchronized="false"
  881. static="false" final="false" visibility="public"
  882. deprecated="not deprecated">
  883. <param name="context" type="org.apache.hadoop.mapred.TaskAttemptContext"/>
  884. <exception name="IOException" type="java.io.IOException"/>
  885. </method>
  886. <field name="LOG" type="org.apache.commons.logging.Log"
  887. transient="false" volatile="false"
  888. static="true" final="true" visibility="public"
  889. deprecated="not deprecated">
  890. </field>
  891. <field name="TEMP_DIR_NAME" type="java.lang.String"
  892. transient="false" volatile="false"
  893. static="true" final="true" visibility="public"
  894. deprecated="not deprecated">
  895. <doc>
  896. <![CDATA[Temporary directory name]]>
  897. </doc>
  898. </field>
  899. <doc>
  900. <![CDATA[An {@link OutputCommitter} that commits files specified
  901. in job output directory i.e. ${mapred.output.dir}.]]>
  902. </doc>
  903. </class>
  904. <!-- end class org.apache.hadoop.mapred.FileOutputCommitter -->
  905. <!-- start class org.apache.hadoop.mapred.FileOutputFormat -->
  906. <class name="FileOutputFormat" extends="java.lang.Object"
  907. abstract="true"
  908. static="false" final="false" visibility="public"
  909. deprecated="not deprecated">
  910. <implements name="org.apache.hadoop.mapred.OutputFormat"/>
  911. <constructor name="FileOutputFormat"
  912. static="false" final="false" visibility="public"
  913. deprecated="not deprecated">
  914. </constructor>
  915. <method name="setCompressOutput"
  916. abstract="false" native="false" synchronized="false"
  917. static="true" final="false" visibility="public"
  918. deprecated="not deprecated">
  919. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  920. <param name="compress" type="boolean"/>
  921. <doc>
  922. <![CDATA[Set whether the output of the job is compressed.
  923. @param conf the {@link JobConf} to modify
  924. @param compress should the output of the job be compressed?]]>
  925. </doc>
  926. </method>
  927. <method name="getCompressOutput" return="boolean"
  928. abstract="false" native="false" synchronized="false"
  929. static="true" final="false" visibility="public"
  930. deprecated="not deprecated">
  931. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  932. <doc>
  933. <![CDATA[Is the job output compressed?
  934. @param conf the {@link JobConf} to look in
  935. @return <code>true</code> if the job output should be compressed,
  936. <code>false</code> otherwise]]>
  937. </doc>
  938. </method>
  939. <method name="setOutputCompressorClass"
  940. abstract="false" native="false" synchronized="false"
  941. static="true" final="false" visibility="public"
  942. deprecated="not deprecated">
  943. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  944. <param name="codecClass" type="java.lang.Class"/>
  945. <doc>
  946. <![CDATA[Set the {@link CompressionCodec} to be used to compress job outputs.
  947. @param conf the {@link JobConf} to modify
  948. @param codecClass the {@link CompressionCodec} to be used to
  949. compress the job outputs]]>
  950. </doc>
  951. </method>
  952. <method name="getOutputCompressorClass" return="java.lang.Class"
  953. abstract="false" native="false" synchronized="false"
  954. static="true" final="false" visibility="public"
  955. deprecated="not deprecated">
  956. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  957. <param name="defaultValue" type="java.lang.Class"/>
  958. <doc>
  959. <![CDATA[Get the {@link CompressionCodec} for compressing the job outputs.
  960. @param conf the {@link JobConf} to look in
  961. @param defaultValue the {@link CompressionCodec} to return if not set
  962. @return the {@link CompressionCodec} to be used to compress the
  963. job outputs
  964. @throws IllegalArgumentException if the class was specified, but not found]]>
  965. </doc>
  966. </method>
  967. <method name="getRecordWriter" return="org.apache.hadoop.mapred.RecordWriter"
  968. abstract="true" native="false" synchronized="false"
  969. static="false" final="false" visibility="public"
  970. deprecated="not deprecated">
  971. <param name="ignored" type="org.apache.hadoop.fs.FileSystem"/>
  972. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  973. <param name="name" type="java.lang.String"/>
  974. <param name="progress" type="org.apache.hadoop.util.Progressable"/>
  975. <exception name="IOException" type="java.io.IOException"/>
  976. </method>
  977. <method name="checkOutputSpecs"
  978. abstract="false" native="false" synchronized="false"
  979. static="false" final="false" visibility="public"
  980. deprecated="not deprecated">
  981. <param name="ignored" type="org.apache.hadoop.fs.FileSystem"/>
  982. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  983. <exception name="FileAlreadyExistsException" type="org.apache.hadoop.mapred.FileAlreadyExistsException"/>
  984. <exception name="InvalidJobConfException" type="org.apache.hadoop.mapred.InvalidJobConfException"/>
  985. <exception name="IOException" type="java.io.IOException"/>
  986. </method>
  987. <method name="setOutputPath"
  988. abstract="false" native="false" synchronized="false"
  989. static="true" final="false" visibility="public"
  990. deprecated="not deprecated">
  991. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  992. <param name="outputDir" type="org.apache.hadoop.fs.Path"/>
  993. <doc>
  994. <![CDATA[Set the {@link Path} of the output directory for the map-reduce job.
  995. @param conf The configuration of the job.
  996. @param outputDir the {@link Path} of the output directory for
  997. the map-reduce job.]]>
  998. </doc>
  999. </method>
  1000. <method name="getOutputPath" return="org.apache.hadoop.fs.Path"
  1001. abstract="false" native="false" synchronized="false"
  1002. static="true" final="false" visibility="public"
  1003. deprecated="not deprecated">
  1004. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  1005. <doc>
  1006. <![CDATA[Get the {@link Path} to the output directory for the map-reduce job.
  1007. @return the {@link Path} to the output directory for the map-reduce job.
  1008. @see FileOutputFormat#getWorkOutputPath(JobConf)]]>
  1009. </doc>
  1010. </method>
  1011. <method name="getWorkOutputPath" return="org.apache.hadoop.fs.Path"
  1012. abstract="false" native="false" synchronized="false"
  1013. static="true" final="false" visibility="public"
  1014. deprecated="not deprecated">
  1015. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  1016. <doc>
  1017. <![CDATA[Get the {@link Path} to the task's temporary output directory
  1018. for the map-reduce job
  1019. <h4 id="SideEffectFiles">Tasks' Side-Effect Files</h4>
  1020. <p><i>Note:</i> The following is valid only if the {@link OutputCommitter}
  1021. is {@link FileOutputCommitter}. If <code>OutputCommitter</code> is not
  1022. a <code>FileOutputCommitter</code>, the task's temporary output
  1023. directory is same as {@link #getOutputPath(JobConf)} i.e.
  1024. <tt>${mapred.output.dir}$</tt></p>
  1025. <p>Some applications need to create/write-to side-files, which differ from
  1026. the actual job-outputs.
  1027. <p>In such cases there could be issues with 2 instances of the same TIP
  1028. (running simultaneously e.g. speculative tasks) trying to open/write-to the
  1029. same file (path) on HDFS. Hence the application-writer will have to pick
  1030. unique names per task-attempt (e.g. using the attemptid, say
  1031. <tt>attempt_200709221812_0001_m_000000_0</tt>), not just per TIP.</p>
  1032. <p>To get around this the Map-Reduce framework helps the application-writer
  1033. out by maintaining a special
  1034. <tt>${mapred.output.dir}/_temporary/_${taskid}</tt>
  1035. sub-directory for each task-attempt on HDFS where the output of the
  1036. task-attempt goes. On successful completion of the task-attempt the files
  1037. in the <tt>${mapred.output.dir}/_temporary/_${taskid}</tt> (only)
  1038. are <i>promoted</i> to <tt>${mapred.output.dir}</tt>. Of course, the
  1039. framework discards the sub-directory of unsuccessful task-attempts. This
  1040. is completely transparent to the application.</p>
  1041. <p>The application-writer can take advantage of this by creating any
  1042. side-files required in <tt>${mapred.work.output.dir}</tt> during execution
  1043. of his reduce-task i.e. via {@link #getWorkOutputPath(JobConf)}, and the
  1044. framework will move them out similarly - thus she doesn't have to pick
  1045. unique paths per task-attempt.</p>
  1046. <p><i>Note</i>: the value of <tt>${mapred.work.output.dir}</tt> during
  1047. execution of a particular task-attempt is actually
  1048. <tt>${mapred.output.dir}/_temporary/_{$taskid}</tt>, and this value is
  1049. set by the map-reduce framework. So, just create any side-files in the
  1050. path returned by {@link #getWorkOutputPath(JobConf)} from map/reduce
  1051. task to take advantage of this feature.</p>
  1052. <p>The entire discussion holds true for maps of jobs with
  1053. reducer=NONE (i.e. 0 reduces) since output of the map, in that case,
  1054. goes directly to HDFS.</p>
  1055. @return the {@link Path} to the task's temporary output directory
  1056. for the map-reduce job.]]>
  1057. </doc>
  1058. </method>
  1059. <method name="getTaskOutputPath" return="org.apache.hadoop.fs.Path"
  1060. abstract="false" native="false" synchronized="false"
  1061. static="true" final="false" visibility="public"
  1062. deprecated="not deprecated">
  1063. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  1064. <param name="name" type="java.lang.String"/>
  1065. <exception name="IOException" type="java.io.IOException"/>
  1066. <doc>
  1067. <![CDATA[Helper function to create the task's temporary output directory and
  1068. return the path to the task's output file.
  1069. @param conf job-configuration
  1070. @param name temporary task-output filename
  1071. @return path to the task's temporary output file
  1072. @throws IOException]]>
  1073. </doc>
  1074. </method>
  1075. <method name="getUniqueName" return="java.lang.String"
  1076. abstract="false" native="false" synchronized="false"
  1077. static="true" final="false" visibility="public"
  1078. deprecated="not deprecated">
  1079. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  1080. <param name="name" type="java.lang.String"/>
  1081. <doc>
  1082. <![CDATA[Helper function to generate a name that is unique for the task.
  1083. <p>The generated name can be used to create custom files from within the
  1084. different tasks for the job, the names for different tasks will not collide
  1085. with each other.</p>
  1086. <p>The given name is postfixed with the task type, 'm' for maps, 'r' for
  1087. reduces and the task partition number. For example, give a name 'test'
  1088. running on the first map o the job the generated name will be
  1089. 'test-m-00000'.</p>
  1090. @param conf the configuration for the job.
  1091. @param name the name to make unique.
  1092. @return a unique name accross all tasks of the job.]]>
  1093. </doc>
  1094. </method>
  1095. <method name="getPathForCustomFile" return="org.apache.hadoop.fs.Path"
  1096. abstract="false" native="false" synchronized="false"
  1097. static="true" final="false" visibility="public"
  1098. deprecated="not deprecated">
  1099. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  1100. <param name="name" type="java.lang.String"/>
  1101. <doc>
  1102. <![CDATA[Helper function to generate a {@link Path} for a file that is unique for
  1103. the task within the job output directory.
  1104. <p>The path can be used to create custom files from within the map and
  1105. reduce tasks. The path name will be unique for each task. The path parent
  1106. will be the job output directory.</p>ls
  1107. <p>This method uses the {@link #getUniqueName} method to make the file name
  1108. unique for the task.</p>
  1109. @param conf the configuration for the job.
  1110. @param name the name for the file.
  1111. @return a unique path accross all tasks of the job.]]>
  1112. </doc>
  1113. </method>
  1114. <doc>
  1115. <![CDATA[A base class for {@link OutputFormat}.]]>
  1116. </doc>
  1117. </class>
  1118. <!-- end class org.apache.hadoop.mapred.FileOutputFormat -->
  1119. <!-- start class org.apache.hadoop.mapred.FileSplit -->
  1120. <class name="FileSplit" extends="org.apache.hadoop.mapreduce.InputSplit"
  1121. abstract="false"
  1122. static="false" final="false" visibility="public"
  1123. deprecated="Use {@link org.apache.hadoop.mapreduce.lib.input.FileSplit}
  1124. instead.">
  1125. <implements name="org.apache.hadoop.mapred.InputSplit"/>
  1126. <constructor name="FileSplit" type="org.apache.hadoop.fs.Path, long, long, org.apache.hadoop.mapred.JobConf"
  1127. static="false" final="false" visibility="public"
  1128. deprecated="deprecated, no comment">
  1129. <doc>
  1130. <![CDATA[Constructs a split.
  1131. @deprecated
  1132. @param file the file name
  1133. @param start the position of the first byte in the file to process
  1134. @param length the number of bytes in the file to process]]>
  1135. </doc>
  1136. </constructor>
  1137. <constructor name="FileSplit" type="org.apache.hadoop.fs.Path, long, long, java.lang.String[]"
  1138. static="false" final="false" visibility="public"
  1139. deprecated="not deprecated">
  1140. <doc>
  1141. <![CDATA[Constructs a split with host information
  1142. @param file the file name
  1143. @param start the position of the first byte in the file to process
  1144. @param length the number of bytes in the file to process
  1145. @param hosts the list of hosts containing the block, possibly null]]>
  1146. </doc>
  1147. </constructor>
  1148. <method name="getPath" return="org.apache.hadoop.fs.Path"
  1149. abstract="false" native="false" synchronized="false"
  1150. static="false" final="false" visibility="public"
  1151. deprecated="not deprecated">
  1152. <doc>
  1153. <![CDATA[The file containing this split's data.]]>
  1154. </doc>
  1155. </method>
  1156. <method name="getStart" return="long"
  1157. abstract="false" native="false" synchronized="false"
  1158. static="false" final="false" visibility="public"
  1159. deprecated="not deprecated">
  1160. <doc>
  1161. <![CDATA[The position of the first byte in the file to process.]]>
  1162. </doc>
  1163. </method>
  1164. <method name="getLength" return="long"
  1165. abstract="false" native="false" synchronized="false"
  1166. static="false" final="false" visibility="public"
  1167. deprecated="not deprecated">
  1168. <doc>
  1169. <![CDATA[The number of bytes in the file to process.]]>
  1170. </doc>
  1171. </method>
  1172. <method name="toString" return="java.lang.String"
  1173. abstract="false" native="false" synchronized="false"
  1174. static="false" final="false" visibility="public"
  1175. deprecated="not deprecated">
  1176. </method>
  1177. <method name="write"
  1178. abstract="false" native="false" synchronized="false"
  1179. static="false" final="false" visibility="public"
  1180. deprecated="not deprecated">
  1181. <param name="out" type="java.io.DataOutput"/>
  1182. <exception name="IOException" type="java.io.IOException"/>
  1183. </method>
  1184. <method name="readFields"
  1185. abstract="false" native="false" synchronized="false"
  1186. static="false" final="false" visibility="public"
  1187. deprecated="not deprecated">
  1188. <param name="in" type="java.io.DataInput"/>
  1189. <exception name="IOException" type="java.io.IOException"/>
  1190. </method>
  1191. <method name="getLocations" return="java.lang.String[]"
  1192. abstract="false" native="false" synchronized="false"
  1193. static="false" final="false" visibility="public"
  1194. deprecated="not deprecated">
  1195. <exception name="IOException" type="java.io.IOException"/>
  1196. </method>
  1197. <doc>
  1198. <![CDATA[A section of an input file. Returned by {@link
  1199. InputFormat#getSplits(JobConf, int)} and passed to
  1200. {@link InputFormat#getRecordReader(InputSplit,JobConf,Reporter)}.
  1201. @deprecated Use {@link org.apache.hadoop.mapreduce.lib.input.FileSplit}
  1202. instead.]]>
  1203. </doc>
  1204. </class>
  1205. <!-- end class org.apache.hadoop.mapred.FileSplit -->
  1206. <!-- start class org.apache.hadoop.mapred.ID -->
  1207. <class name="ID" extends="org.apache.hadoop.mapreduce.ID"
  1208. abstract="true"
  1209. static="false" final="false" visibility="public"
  1210. deprecated="not deprecated">
  1211. <constructor name="ID" type="int"
  1212. static="false" final="false" visibility="public"
  1213. deprecated="not deprecated">
  1214. <doc>
  1215. <![CDATA[constructs an ID object from the given int]]>
  1216. </doc>
  1217. </constructor>
  1218. <constructor name="ID"
  1219. static="false" final="false" visibility="protected"
  1220. deprecated="not deprecated">
  1221. </constructor>
  1222. <doc>
  1223. <![CDATA[A general identifier, which internally stores the id
  1224. as an integer. This is the super class of {@link JobID},
  1225. {@link TaskID} and {@link TaskAttemptID}.
  1226. @see JobID
  1227. @see TaskID
  1228. @see TaskAttemptID]]>
  1229. </doc>
  1230. </class>
  1231. <!-- end class org.apache.hadoop.mapred.ID -->
  1232. <!-- start interface org.apache.hadoop.mapred.InputFormat -->
  1233. <interface name="InputFormat" abstract="true"
  1234. static="false" final="false" visibility="public"
  1235. deprecated="Use {@link org.apache.hadoop.mapreduce.InputFormat} instead.">
  1236. <method name="getSplits" return="org.apache.hadoop.mapred.InputSplit[]"
  1237. abstract="false" native="false" synchronized="false"
  1238. static="false" final="false" visibility="public"
  1239. deprecated="not deprecated">
  1240. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  1241. <param name="numSplits" type="int"/>
  1242. <exception name="IOException" type="java.io.IOException"/>
  1243. <doc>
  1244. <![CDATA[Logically split the set of input files for the job.
  1245. <p>Each {@link InputSplit} is then assigned to an individual {@link Mapper}
  1246. for processing.</p>
  1247. <p><i>Note</i>: The split is a <i>logical</i> split of the inputs and the
  1248. input files are not physically split into chunks. For e.g. a split could
  1249. be <i>&lt;input-file-path, start, offset&gt;</i> tuple.
  1250. @param job job configuration.
  1251. @param numSplits the desired number of splits, a hint.
  1252. @return an array of {@link InputSplit}s for the job.]]>
  1253. </doc>
  1254. </method>
  1255. <method name="getRecordReader" return="org.apache.hadoop.mapred.RecordReader"
  1256. abstract="false" native="false" synchronized="false"
  1257. static="false" final="false" visibility="public"
  1258. deprecated="not deprecated">
  1259. <param name="split" type="org.apache.hadoop.mapred.InputSplit"/>
  1260. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  1261. <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
  1262. <exception name="IOException" type="java.io.IOException"/>
  1263. <doc>
  1264. <![CDATA[Get the {@link RecordReader} for the given {@link InputSplit}.
  1265. <p>It is the responsibility of the <code>RecordReader</code> to respect
  1266. record boundaries while processing the logical split to present a
  1267. record-oriented view to the individual task.</p>
  1268. @param split the {@link InputSplit}
  1269. @param job the job that this split belongs to
  1270. @return a {@link RecordReader}]]>
  1271. </doc>
  1272. </method>
  1273. <doc>
  1274. <![CDATA[<code>InputFormat</code> describes the input-specification for a
  1275. Map-Reduce job.
  1276. <p>The Map-Reduce framework relies on the <code>InputFormat</code> of the
  1277. job to:<p>
  1278. <ol>
  1279. <li>
  1280. Validate the input-specification of the job.
  1281. <li>
  1282. Split-up the input file(s) into logical {@link InputSplit}s, each of
  1283. which is then assigned to an individual {@link Mapper}.
  1284. </li>
  1285. <li>
  1286. Provide the {@link RecordReader} implementation to be used to glean
  1287. input records from the logical <code>InputSplit</code> for processing by
  1288. the {@link Mapper}.
  1289. </li>
  1290. </ol>
  1291. <p>The default behavior of file-based {@link InputFormat}s, typically
  1292. sub-classes of {@link FileInputFormat}, is to split the
  1293. input into <i>logical</i> {@link InputSplit}s based on the total size, in
  1294. bytes, of the input files. However, the {@link FileSystem} blocksize of
  1295. the input files is treated as an upper bound for input splits. A lower bound
  1296. on the split size can be set via
  1297. <a href="{@docRoot}/../mapred-default.html#mapred.min.split.size">
  1298. mapred.min.split.size</a>.</p>
  1299. <p>Clearly, logical splits based on input-size is insufficient for many
  1300. applications since record boundaries are to respected. In such cases, the
  1301. application has to also implement a {@link RecordReader} on whom lies the
  1302. responsibilty to respect record-boundaries and present a record-oriented
  1303. view of the logical <code>InputSplit</code> to the individual task.
  1304. @see InputSplit
  1305. @see RecordReader
  1306. @see JobClient
  1307. @see FileInputFormat
  1308. @deprecated Use {@link org.apache.hadoop.mapreduce.InputFormat} instead.]]>
  1309. </doc>
  1310. </interface>
  1311. <!-- end interface org.apache.hadoop.mapred.InputFormat -->
  1312. <!-- start interface org.apache.hadoop.mapred.InputSplit -->
  1313. <interface name="InputSplit" abstract="true"
  1314. static="false" final="false" visibility="public"
  1315. deprecated="Use {@link org.apache.hadoop.mapreduce.InputSplit} instead.">
  1316. <implements name="org.apache.hadoop.io.Writable"/>
  1317. <method name="getLength" return="long"
  1318. abstract="false" native="false" synchronized="false"
  1319. static="false" final="false" visibility="public"
  1320. deprecated="not deprecated">
  1321. <exception name="IOException" type="java.io.IOException"/>
  1322. <doc>
  1323. <![CDATA[Get the total number of bytes in the data of the <code>InputSplit</code>.
  1324. @return the number of bytes in the input split.
  1325. @throws IOException]]>
  1326. </doc>
  1327. </method>
  1328. <method name="getLocations" return="java.lang.String[]"
  1329. abstract="false" native="false" synchronized="false"
  1330. static="false" final="false" visibility="public"
  1331. deprecated="not deprecated">
  1332. <exception name="IOException" type="java.io.IOException"/>
  1333. <doc>
  1334. <![CDATA[Get the list of hostnames where the input split is located.
  1335. @return list of hostnames where data of the <code>InputSplit</code> is
  1336. located as an array of <code>String</code>s.
  1337. @throws IOException]]>
  1338. </doc>
  1339. </method>
  1340. <doc>
  1341. <![CDATA[<code>InputSplit</code> represents the data to be processed by an
  1342. individual {@link Mapper}.
  1343. <p>Typically, it presents a byte-oriented view on the input and is the
  1344. responsibility of {@link RecordReader} of the job to process this and present
  1345. a record-oriented view.
  1346. @see InputFormat
  1347. @see RecordReader
  1348. @deprecated Use {@link org.apache.hadoop.mapreduce.InputSplit} instead.]]>
  1349. </doc>
  1350. </interface>
  1351. <!-- end interface org.apache.hadoop.mapred.InputSplit -->
  1352. <!-- start class org.apache.hadoop.mapred.InvalidFileTypeException -->
  1353. <class name="InvalidFileTypeException" extends="java.io.IOException"
  1354. abstract="false"
  1355. static="false" final="false" visibility="public"
  1356. deprecated="not deprecated">
  1357. <constructor name="InvalidFileTypeException"
  1358. static="false" final="false" visibility="public"
  1359. deprecated="not deprecated">
  1360. </constructor>
  1361. <constructor name="InvalidFileTypeException" type="java.lang.String"
  1362. static="false" final="false" visibility="public"
  1363. deprecated="not deprecated">
  1364. </constructor>
  1365. <doc>
  1366. <![CDATA[Used when file type differs from the desired file type. like
  1367. getting a file when a directory is expected. Or a wrong file type.]]>
  1368. </doc>
  1369. </class>
  1370. <!-- end class org.apache.hadoop.mapred.InvalidFileTypeException -->
  1371. <!-- start class org.apache.hadoop.mapred.InvalidInputException -->
  1372. <class name="InvalidInputException" extends="java.io.IOException"
  1373. abstract="false"
  1374. static="false" final="false" visibility="public"
  1375. deprecated="not deprecated">
  1376. <constructor name="InvalidInputException" type="java.util.List"
  1377. static="false" final="false" visibility="public"
  1378. deprecated="not deprecated">
  1379. <doc>
  1380. <![CDATA[Create the exception with the given list.
  1381. @param probs the list of problems to report. this list is not copied.]]>
  1382. </doc>
  1383. </constructor>
  1384. <method name="getProblems" return="java.util.List"
  1385. abstract="false" native="false" synchronized="false"
  1386. static="false" final="false" visibility="public"
  1387. deprecated="not deprecated">
  1388. <doc>
  1389. <![CDATA[Get the complete list of the problems reported.
  1390. @return the list of problems, which must not be modified]]>
  1391. </doc>
  1392. </method>
  1393. <method name="getMessage" return="java.lang.String"
  1394. abstract="false" native="false" synchronized="false"
  1395. static="false" final="false" visibility="public"
  1396. deprecated="not deprecated">
  1397. <doc>
  1398. <![CDATA[Get a summary message of the problems found.
  1399. @return the concatenated messages from all of the problems.]]>
  1400. </doc>
  1401. </method>
  1402. <doc>
  1403. <![CDATA[This class wraps a list of problems with the input, so that the user
  1404. can get a list of problems together instead of finding and fixing them one
  1405. by one.]]>
  1406. </doc>
  1407. </class>
  1408. <!-- end class org.apache.hadoop.mapred.InvalidInputException -->
  1409. <!-- start class org.apache.hadoop.mapred.InvalidJobConfException -->
  1410. <class name="InvalidJobConfException" extends="java.io.IOException"
  1411. abstract="false"
  1412. static="false" final="false" visibility="public"
  1413. deprecated="not deprecated">
  1414. <constructor name="InvalidJobConfException"
  1415. static="false" final="false" visibility="public"
  1416. deprecated="not deprecated">
  1417. </constructor>
  1418. <constructor name="InvalidJobConfException" type="java.lang.String"
  1419. static="false" final="false" visibility="public"
  1420. deprecated="not deprecated">
  1421. </constructor>
  1422. <doc>
  1423. <![CDATA[This exception is thrown when jobconf misses some mendatory attributes
  1424. or value of some attributes is invalid.]]>
  1425. </doc>
  1426. </class>
  1427. <!-- end class org.apache.hadoop.mapred.InvalidJobConfException -->
  1428. <!-- start class org.apache.hadoop.mapred.IsolationRunner -->
  1429. <class name="IsolationRunner" extends="java.lang.Object"
  1430. abstract="false"
  1431. static="false" final="false" visibility="public"
  1432. deprecated="not deprecated">
  1433. <constructor name="IsolationRunner"
  1434. static="false" final="false" visibility="public"
  1435. deprecated="not deprecated">
  1436. </constructor>
  1437. <method name="main"
  1438. abstract="false" native="false" synchronized="false"
  1439. static="true" final="false" visibility="public"
  1440. deprecated="not deprecated">
  1441. <param name="args" type="java.lang.String[]"/>
  1442. <exception name="ClassNotFoundException" type="java.lang.ClassNotFoundException"/>
  1443. <exception name="IOException" type="java.io.IOException"/>
  1444. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  1445. <doc>
  1446. <![CDATA[Run a single task
  1447. @param args the first argument is the task directory]]>
  1448. </doc>
  1449. </method>
  1450. </class>
  1451. <!-- end class org.apache.hadoop.mapred.IsolationRunner -->
  1452. <!-- start class org.apache.hadoop.mapred.JobClient -->
  1453. <class name="JobClient" extends="org.apache.hadoop.conf.Configured"
  1454. abstract="false"
  1455. static="false" final="false" visibility="public"
  1456. deprecated="not deprecated">
  1457. <implements name="org.apache.hadoop.mapred.MRConstants"/>
  1458. <implements name="org.apache.hadoop.util.Tool"/>
  1459. <constructor name="JobClient"
  1460. static="false" final="false" visibility="public"
  1461. deprecated="not deprecated">
  1462. <doc>
  1463. <![CDATA[Create a job client.]]>
  1464. </doc>
  1465. </constructor>
  1466. <constructor name="JobClient" type="org.apache.hadoop.mapred.JobConf"
  1467. static="false" final="false" visibility="public"
  1468. deprecated="not deprecated">
  1469. <exception name="IOException" type="java.io.IOException"/>
  1470. <doc>
  1471. <![CDATA[Build a job client with the given {@link JobConf}, and connect to the
  1472. default {@link JobTracker}.
  1473. @param conf the job configuration.
  1474. @throws IOException]]>
  1475. </doc>
  1476. </constructor>
  1477. <constructor name="JobClient" type="java.net.InetSocketAddress, org.apache.hadoop.conf.Configuration"
  1478. static="false" final="false" visibility="public"
  1479. deprecated="not deprecated">
  1480. <exception name="IOException" type="java.io.IOException"/>
  1481. <doc>
  1482. <![CDATA[Build a job client, connect to the indicated job tracker.
  1483. @param jobTrackAddr the job tracker to connect to.
  1484. @param conf configuration.]]>
  1485. </doc>
  1486. </constructor>
  1487. <method name="init"
  1488. abstract="false" native="false" synchronized="false"
  1489. static="false" final="false" visibility="public"
  1490. deprecated="not deprecated">
  1491. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  1492. <exception name="IOException" type="java.io.IOException"/>
  1493. <doc>
  1494. <![CDATA[Connect to the default {@link JobTracker}.
  1495. @param conf the job configuration.
  1496. @throws IOException]]>
  1497. </doc>
  1498. </method>
  1499. <method name="close"
  1500. abstract="false" native="false" synchronized="true"
  1501. static="false" final="false" visibility="public"
  1502. deprecated="not deprecated">
  1503. <exception name="IOException" type="java.io.IOException"/>
  1504. <doc>
  1505. <![CDATA[Close the <code>JobClient</code>.]]>
  1506. </doc>
  1507. </method>
  1508. <method name="getFs" return="org.apache.hadoop.fs.FileSystem"
  1509. abstract="false" native="false" synchronized="true"
  1510. static="false" final="false" visibility="public"
  1511. deprecated="not deprecated">
  1512. <exception name="IOException" type="java.io.IOException"/>
  1513. <doc>
  1514. <![CDATA[Get a filesystem handle. We need this to prepare jobs
  1515. for submission to the MapReduce system.
  1516. @return the filesystem handle.]]>
  1517. </doc>
  1518. </method>
  1519. <method name="submitJob" return="org.apache.hadoop.mapred.RunningJob"
  1520. abstract="false" native="false" synchronized="false"
  1521. static="false" final="false" visibility="public"
  1522. deprecated="not deprecated">
  1523. <param name="jobFile" type="java.lang.String"/>
  1524. <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
  1525. <exception name="InvalidJobConfException" type="org.apache.hadoop.mapred.InvalidJobConfException"/>
  1526. <exception name="IOException" type="java.io.IOException"/>
  1527. <doc>
  1528. <![CDATA[Submit a job to the MR system.
  1529. This returns a handle to the {@link RunningJob} which can be used to track
  1530. the running-job.
  1531. @param jobFile the job configuration.
  1532. @return a handle to the {@link RunningJob} which can be used to track the
  1533. running-job.
  1534. @throws FileNotFoundException
  1535. @throws InvalidJobConfException
  1536. @throws IOException]]>
  1537. </doc>
  1538. </method>
  1539. <method name="submitJob" return="org.apache.hadoop.mapred.RunningJob"
  1540. abstract="false" native="false" synchronized="false"
  1541. static="false" final="false" visibility="public"
  1542. deprecated="not deprecated">
  1543. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  1544. <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
  1545. <exception name="IOException" type="java.io.IOException"/>
  1546. <doc>
  1547. <![CDATA[Submit a job to the MR system.
  1548. This returns a handle to the {@link RunningJob} which can be used to track
  1549. the running-job.
  1550. @param job the job configuration.
  1551. @return a handle to the {@link RunningJob} which can be used to track the
  1552. running-job.
  1553. @throws FileNotFoundException
  1554. @throws IOException]]>
  1555. </doc>
  1556. </method>
  1557. <method name="submitJobInternal" return="org.apache.hadoop.mapred.RunningJob"
  1558. abstract="false" native="false" synchronized="false"
  1559. static="false" final="false" visibility="public"
  1560. deprecated="not deprecated">
  1561. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  1562. <exception name="FileNotFoundException" type="java.io.FileNotFoundException"/>
  1563. <exception name="ClassNotFoundException" type="java.lang.ClassNotFoundException"/>
  1564. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  1565. <exception name="IOException" type="java.io.IOException"/>
  1566. <doc>
  1567. <![CDATA[Internal method for submitting jobs to the system.
  1568. @param job the configuration to submit
  1569. @return a proxy object for the running job
  1570. @throws FileNotFoundException
  1571. @throws ClassNotFoundException
  1572. @throws InterruptedException
  1573. @throws IOException]]>
  1574. </doc>
  1575. </method>
  1576. <method name="isJobDirValid" return="boolean"
  1577. abstract="false" native="false" synchronized="false"
  1578. static="true" final="false" visibility="public"
  1579. deprecated="not deprecated">
  1580. <param name="jobDirPath" type="org.apache.hadoop.fs.Path"/>
  1581. <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
  1582. <exception name="IOException" type="java.io.IOException"/>
  1583. <doc>
  1584. <![CDATA[Checks if the job directory is clean and has all the required components
  1585. for (re) starting the job]]>
  1586. </doc>
  1587. </method>
  1588. <method name="getJob" return="org.apache.hadoop.mapred.RunningJob"
  1589. abstract="false" native="false" synchronized="false"
  1590. static="false" final="false" visibility="public"
  1591. deprecated="not deprecated">
  1592. <param name="jobid" type="org.apache.hadoop.mapred.JobID"/>
  1593. <exception name="IOException" type="java.io.IOException"/>
  1594. <doc>
  1595. <![CDATA[Get an {@link RunningJob} object to track an ongoing job. Returns
  1596. null if the id does not correspond to any known job.
  1597. @param jobid the jobid of the job.
  1598. @return the {@link RunningJob} handle to track the job, null if the
  1599. <code>jobid</code> doesn't correspond to any known job.
  1600. @throws IOException]]>
  1601. </doc>
  1602. </method>
  1603. <method name="getJob" return="org.apache.hadoop.mapred.RunningJob"
  1604. abstract="false" native="false" synchronized="false"
  1605. static="false" final="false" visibility="public"
  1606. deprecated="Applications should rather use {@link #getJob(JobID)}.">
  1607. <param name="jobid" type="java.lang.String"/>
  1608. <exception name="IOException" type="java.io.IOException"/>
  1609. <doc>
  1610. <![CDATA[@deprecated Applications should rather use {@link #getJob(JobID)}.]]>
  1611. </doc>
  1612. </method>
  1613. <method name="getMapTaskReports" return="org.apache.hadoop.mapred.TaskReport[]"
  1614. abstract="false" native="false" synchronized="false"
  1615. static="false" final="false" visibility="public"
  1616. deprecated="not deprecated">
  1617. <param name="jobId" type="org.apache.hadoop.mapred.JobID"/>
  1618. <exception name="IOException" type="java.io.IOException"/>
  1619. <doc>
  1620. <![CDATA[Get the information of the current state of the map tasks of a job.
  1621. @param jobId the job to query.
  1622. @return the list of all of the map tips.
  1623. @throws IOException]]>
  1624. </doc>
  1625. </method>
  1626. <method name="getMapTaskReports" return="org.apache.hadoop.mapred.TaskReport[]"
  1627. abstract="false" native="false" synchronized="false"
  1628. static="false" final="false" visibility="public"
  1629. deprecated="Applications should rather use {@link #getMapTaskReports(JobID)}">
  1630. <param name="jobId" type="java.lang.String"/>
  1631. <exception name="IOException" type="java.io.IOException"/>
  1632. <doc>
  1633. <![CDATA[@deprecated Applications should rather use {@link #getMapTaskReports(JobID)}]]>
  1634. </doc>
  1635. </method>
  1636. <method name="getReduceTaskReports" return="org.apache.hadoop.mapred.TaskReport[]"
  1637. abstract="false" native="false" synchronized="false"
  1638. static="false" final="false" visibility="public"
  1639. deprecated="not deprecated">
  1640. <param name="jobId" type="org.apache.hadoop.mapred.JobID"/>
  1641. <exception name="IOException" type="java.io.IOException"/>
  1642. <doc>
  1643. <![CDATA[Get the information of the current state of the reduce tasks of a job.
  1644. @param jobId the job to query.
  1645. @return the list of all of the reduce tips.
  1646. @throws IOException]]>
  1647. </doc>
  1648. </method>
  1649. <method name="getCleanupTaskReports" return="org.apache.hadoop.mapred.TaskReport[]"
  1650. abstract="false" native="false" synchronized="false"
  1651. static="false" final="false" visibility="public"
  1652. deprecated="not deprecated">
  1653. <param name="jobId" type="org.apache.hadoop.mapred.JobID"/>
  1654. <exception name="IOException" type="java.io.IOException"/>
  1655. <doc>
  1656. <![CDATA[Get the information of the current state of the cleanup tasks of a job.
  1657. @param jobId the job to query.
  1658. @return the list of all of the cleanup tips.
  1659. @throws IOException]]>
  1660. </doc>
  1661. </method>
  1662. <method name="getSetupTaskReports" return="org.apache.hadoop.mapred.TaskReport[]"
  1663. abstract="false" native="false" synchronized="false"
  1664. static="false" final="false" visibility="public"
  1665. deprecated="not deprecated">
  1666. <param name="jobId" type="org.apache.hadoop.mapred.JobID"/>
  1667. <exception name="IOException" type="java.io.IOException"/>
  1668. <doc>
  1669. <![CDATA[Get the information of the current state of the setup tasks of a job.
  1670. @param jobId the job to query.
  1671. @return the list of all of the setup tips.
  1672. @throws IOException]]>
  1673. </doc>
  1674. </method>
  1675. <method name="getReduceTaskReports" return="org.apache.hadoop.mapred.TaskReport[]"
  1676. abstract="false" native="false" synchronized="false"
  1677. static="false" final="false" visibility="public"
  1678. deprecated="Applications should rather use {@link #getReduceTaskReports(JobID)}">
  1679. <param name="jobId" type="java.lang.String"/>
  1680. <exception name="IOException" type="java.io.IOException"/>
  1681. <doc>
  1682. <![CDATA[@deprecated Applications should rather use {@link #getReduceTaskReports(JobID)}]]>
  1683. </doc>
  1684. </method>
  1685. <method name="displayTasks"
  1686. abstract="false" native="false" synchronized="false"
  1687. static="false" final="false" visibility="public"
  1688. deprecated="not deprecated">
  1689. <param name="jobId" type="org.apache.hadoop.mapred.JobID"/>
  1690. <param name="type" type="java.lang.String"/>
  1691. <param name="state" type="java.lang.String"/>
  1692. <exception name="IOException" type="java.io.IOException"/>
  1693. <doc>
  1694. <![CDATA[Display the information about a job's tasks, of a particular type and
  1695. in a particular state
  1696. @param jobId the ID of the job
  1697. @param type the type of the task (map/reduce/setup/cleanup)
  1698. @param state the state of the task
  1699. (pending/running/completed/failed/killed)]]>
  1700. </doc>
  1701. </method>
  1702. <method name="getClusterStatus" return="org.apache.hadoop.mapred.ClusterStatus"
  1703. abstract="false" native="false" synchronized="false"
  1704. static="false" final="false" visibility="public"
  1705. deprecated="not deprecated">
  1706. <exception name="IOException" type="java.io.IOException"/>
  1707. <doc>
  1708. <![CDATA[Get status information about the Map-Reduce cluster.
  1709. @return the status information about the Map-Reduce cluster as an object
  1710. of {@link ClusterStatus}.
  1711. @throws IOException]]>
  1712. </doc>
  1713. </method>
  1714. <method name="getClusterStatus" return="org.apache.hadoop.mapred.ClusterStatus"
  1715. abstract="false" native="false" synchronized="false"
  1716. static="false" final="false" visibility="public"
  1717. deprecated="not deprecated">
  1718. <param name="detailed" type="boolean"/>
  1719. <exception name="IOException" type="java.io.IOException"/>
  1720. <doc>
  1721. <![CDATA[Get status information about the Map-Reduce cluster.
  1722. @param detailed if true then get a detailed status including the
  1723. tracker names
  1724. @return the status information about the Map-Reduce cluster as an object
  1725. of {@link ClusterStatus}.
  1726. @throws IOException]]>
  1727. </doc>
  1728. </method>
  1729. <method name="jobsToComplete" return="org.apache.hadoop.mapred.JobStatus[]"
  1730. abstract="false" native="false" synchronized="false"
  1731. static="false" final="false" visibility="public"
  1732. deprecated="not deprecated">
  1733. <exception name="IOException" type="java.io.IOException"/>
  1734. <doc>
  1735. <![CDATA[Get the jobs that are not completed and not failed.
  1736. @return array of {@link JobStatus} for the running/to-be-run jobs.
  1737. @throws IOException]]>
  1738. </doc>
  1739. </method>
  1740. <method name="getAllJobs" return="org.apache.hadoop.mapred.JobStatus[]"
  1741. abstract="false" native="false" synchronized="false"
  1742. static="false" final="false" visibility="public"
  1743. deprecated="not deprecated">
  1744. <exception name="IOException" type="java.io.IOException"/>
  1745. <doc>
  1746. <![CDATA[Get the jobs that are submitted.
  1747. @return array of {@link JobStatus} for the submitted jobs.
  1748. @throws IOException]]>
  1749. </doc>
  1750. </method>
  1751. <method name="runJob" return="org.apache.hadoop.mapred.RunningJob"
  1752. abstract="false" native="false" synchronized="false"
  1753. static="true" final="false" visibility="public"
  1754. deprecated="not deprecated">
  1755. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  1756. <exception name="IOException" type="java.io.IOException"/>
  1757. <doc>
  1758. <![CDATA[Utility that submits a job, then polls for progress until the job is
  1759. complete.
  1760. @param job the job configuration.
  1761. @throws IOException if the job fails]]>
  1762. </doc>
  1763. </method>
  1764. <method name="monitorAndPrintJob" return="boolean"
  1765. abstract="false" native="false" synchronized="false"
  1766. static="false" final="false" visibility="public"
  1767. deprecated="not deprecated">
  1768. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  1769. <param name="job" type="org.apache.hadoop.mapred.RunningJob"/>
  1770. <exception name="IOException" type="java.io.IOException"/>
  1771. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  1772. <doc>
  1773. <![CDATA[Monitor a job and print status in real-time as progress is made and tasks
  1774. fail.
  1775. @param conf the job's configuration
  1776. @param job the job to track
  1777. @return true if the job succeeded
  1778. @throws IOException if communication to the JobTracker fails]]>
  1779. </doc>
  1780. </method>
  1781. <method name="setTaskOutputFilter"
  1782. abstract="false" native="false" synchronized="false"
  1783. static="false" final="false" visibility="public"
  1784. deprecated="not deprecated">
  1785. <param name="newValue" type="org.apache.hadoop.mapred.JobClient.TaskStatusFilter"/>
  1786. <doc>
  1787. <![CDATA[Sets the output filter for tasks. only those tasks are printed whose
  1788. output matches the filter.
  1789. @param newValue task filter.]]>
  1790. </doc>
  1791. </method>
  1792. <method name="getTaskOutputFilter" return="org.apache.hadoop.mapred.JobClient.TaskStatusFilter"
  1793. abstract="false" native="false" synchronized="false"
  1794. static="true" final="false" visibility="public"
  1795. deprecated="not deprecated">
  1796. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  1797. <doc>
  1798. <![CDATA[Get the task output filter out of the JobConf.
  1799. @param job the JobConf to examine.
  1800. @return the filter level.]]>
  1801. </doc>
  1802. </method>
  1803. <method name="setTaskOutputFilter"
  1804. abstract="false" native="false" synchronized="false"
  1805. static="true" final="false" visibility="public"
  1806. deprecated="not deprecated">
  1807. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  1808. <param name="newValue" type="org.apache.hadoop.mapred.JobClient.TaskStatusFilter"/>
  1809. <doc>
  1810. <![CDATA[Modify the JobConf to set the task output filter.
  1811. @param job the JobConf to modify.
  1812. @param newValue the value to set.]]>
  1813. </doc>
  1814. </method>
  1815. <method name="getTaskOutputFilter" return="org.apache.hadoop.mapred.JobClient.TaskStatusFilter"
  1816. abstract="false" native="false" synchronized="false"
  1817. static="false" final="false" visibility="public"
  1818. deprecated="not deprecated">
  1819. <doc>
  1820. <![CDATA[Returns task output filter.
  1821. @return task filter.]]>
  1822. </doc>
  1823. </method>
  1824. <method name="run" return="int"
  1825. abstract="false" native="false" synchronized="false"
  1826. static="false" final="false" visibility="public"
  1827. deprecated="not deprecated">
  1828. <param name="argv" type="java.lang.String[]"/>
  1829. <exception name="Exception" type="java.lang.Exception"/>
  1830. </method>
  1831. <method name="getDefaultMaps" return="int"
  1832. abstract="false" native="false" synchronized="false"
  1833. static="false" final="false" visibility="public"
  1834. deprecated="not deprecated">
  1835. <exception name="IOException" type="java.io.IOException"/>
  1836. <doc>
  1837. <![CDATA[Get status information about the max available Maps in the cluster.
  1838. @return the max available Maps in the cluster
  1839. @throws IOException]]>
  1840. </doc>
  1841. </method>
  1842. <method name="getDefaultReduces" return="int"
  1843. abstract="false" native="false" synchronized="false"
  1844. static="false" final="false" visibility="public"
  1845. deprecated="not deprecated">
  1846. <exception name="IOException" type="java.io.IOException"/>
  1847. <doc>
  1848. <![CDATA[Get status information about the max available Reduces in the cluster.
  1849. @return the max available Reduces in the cluster
  1850. @throws IOException]]>
  1851. </doc>
  1852. </method>
  1853. <method name="getSystemDir" return="org.apache.hadoop.fs.Path"
  1854. abstract="false" native="false" synchronized="false"
  1855. static="false" final="false" visibility="public"
  1856. deprecated="not deprecated">
  1857. <doc>
  1858. <![CDATA[Grab the jobtracker system directory path where job-specific files are to be placed.
  1859. @return the system directory where job-specific files are to be placed.]]>
  1860. </doc>
  1861. </method>
  1862. <method name="getQueues" return="org.apache.hadoop.mapred.JobQueueInfo[]"
  1863. abstract="false" native="false" synchronized="false"
  1864. static="false" final="false" visibility="public"
  1865. deprecated="not deprecated">
  1866. <exception name="IOException" type="java.io.IOException"/>
  1867. <doc>
  1868. <![CDATA[Return an array of queue information objects about all the Job Queues
  1869. configured.
  1870. @return Array of JobQueueInfo objects
  1871. @throws IOException]]>
  1872. </doc>
  1873. </method>
  1874. <method name="getJobsFromQueue" return="org.apache.hadoop.mapred.JobStatus[]"
  1875. abstract="false" native="false" synchronized="false"
  1876. static="false" final="false" visibility="public"
  1877. deprecated="not deprecated">
  1878. <param name="queueName" type="java.lang.String"/>
  1879. <exception name="IOException" type="java.io.IOException"/>
  1880. <doc>
  1881. <![CDATA[Gets all the jobs which were added to particular Job Queue
  1882. @param queueName name of the Job Queue
  1883. @return Array of jobs present in the job queue
  1884. @throws IOException]]>
  1885. </doc>
  1886. </method>
  1887. <method name="getQueueInfo" return="org.apache.hadoop.mapred.JobQueueInfo"
  1888. abstract="false" native="false" synchronized="false"
  1889. static="false" final="false" visibility="public"
  1890. deprecated="not deprecated">
  1891. <param name="queueName" type="java.lang.String"/>
  1892. <exception name="IOException" type="java.io.IOException"/>
  1893. <doc>
  1894. <![CDATA[Gets the queue information associated to a particular Job Queue
  1895. @param queueName name of the job queue.
  1896. @return Queue information associated to particular queue.
  1897. @throws IOException]]>
  1898. </doc>
  1899. </method>
  1900. <method name="main"
  1901. abstract="false" native="false" synchronized="false"
  1902. static="true" final="false" visibility="public"
  1903. deprecated="not deprecated">
  1904. <param name="argv" type="java.lang.String[]"/>
  1905. <exception name="Exception" type="java.lang.Exception"/>
  1906. </method>
  1907. <doc>
  1908. <![CDATA[<code>JobClient</code> is the primary interface for the user-job to interact
  1909. with the {@link JobTracker}.
  1910. <code>JobClient</code> provides facilities to submit jobs, track their
  1911. progress, access component-tasks' reports/logs, get the Map-Reduce cluster
  1912. status information etc.
  1913. <p>The job submission process involves:
  1914. <ol>
  1915. <li>
  1916. Checking the input and output specifications of the job.
  1917. </li>
  1918. <li>
  1919. Computing the {@link InputSplit}s for the job.
  1920. </li>
  1921. <li>
  1922. Setup the requisite accounting information for the {@link DistributedCache}
  1923. of the job, if necessary.
  1924. </li>
  1925. <li>
  1926. Copying the job's jar and configuration to the map-reduce system directory
  1927. on the distributed file-system.
  1928. </li>
  1929. <li>
  1930. Submitting the job to the <code>JobTracker</code> and optionally monitoring
  1931. it's status.
  1932. </li>
  1933. </ol></p>
  1934. Normally the user creates the application, describes various facets of the
  1935. job via {@link JobConf} and then uses the <code>JobClient</code> to submit
  1936. the job and monitor its progress.
  1937. <p>Here is an example on how to use <code>JobClient</code>:</p>
  1938. <p><blockquote><pre>
  1939. // Create a new JobConf
  1940. JobConf job = new JobConf(new Configuration(), MyJob.class);
  1941. // Specify various job-specific parameters
  1942. job.setJobName("myjob");
  1943. job.setInputPath(new Path("in"));
  1944. job.setOutputPath(new Path("out"));
  1945. job.setMapperClass(MyJob.MyMapper.class);
  1946. job.setReducerClass(MyJob.MyReducer.class);
  1947. // Submit the job, then poll for progress until the job is complete
  1948. JobClient.runJob(job);
  1949. </pre></blockquote></p>
  1950. <h4 id="JobControl">Job Control</h4>
  1951. <p>At times clients would chain map-reduce jobs to accomplish complex tasks
  1952. which cannot be done via a single map-reduce job. This is fairly easy since
  1953. the output of the job, typically, goes to distributed file-system and that
  1954. can be used as the input for the next job.</p>
  1955. <p>However, this also means that the onus on ensuring jobs are complete
  1956. (success/failure) lies squarely on the clients. In such situations the
  1957. various job-control options are:
  1958. <ol>
  1959. <li>
  1960. {@link #runJob(JobConf)} : submits the job and returns only after
  1961. the job has completed.
  1962. </li>
  1963. <li>
  1964. {@link #submitJob(JobConf)} : only submits the job, then poll the
  1965. returned handle to the {@link RunningJob} to query status and make
  1966. scheduling decisions.
  1967. </li>
  1968. <li>
  1969. {@link JobConf#setJobEndNotificationURI(String)} : setup a notification
  1970. on job-completion, thus avoiding polling.
  1971. </li>
  1972. </ol></p>
  1973. @see JobConf
  1974. @see ClusterStatus
  1975. @see Tool
  1976. @see DistributedCache]]>
  1977. </doc>
  1978. </class>
  1979. <!-- end class org.apache.hadoop.mapred.JobClient -->
  1980. <!-- start class org.apache.hadoop.mapred.JobClient.TaskStatusFilter -->
  1981. <class name="JobClient.TaskStatusFilter" extends="java.lang.Enum"
  1982. abstract="false"
  1983. static="true" final="true" visibility="public"
  1984. deprecated="not deprecated">
  1985. <method name="values" return="org.apache.hadoop.mapred.JobClient.TaskStatusFilter[]"
  1986. abstract="false" native="false" synchronized="false"
  1987. static="true" final="false" visibility="public"
  1988. deprecated="not deprecated">
  1989. </method>
  1990. <method name="valueOf" return="org.apache.hadoop.mapred.JobClient.TaskStatusFilter"
  1991. abstract="false" native="false" synchronized="false"
  1992. static="true" final="false" visibility="public"
  1993. deprecated="not deprecated">
  1994. <param name="name" type="java.lang.String"/>
  1995. </method>
  1996. <field name="NONE" type="org.apache.hadoop.mapred.JobClient.TaskStatusFilter"
  1997. transient="false" volatile="false"
  1998. static="true" final="true" visibility="public"
  1999. deprecated="not deprecated">
  2000. </field>
  2001. <field name="KILLED" type="org.apache.hadoop.mapred.JobClient.TaskStatusFilter"
  2002. transient="false" volatile="false"
  2003. static="true" final="true" visibility="public"
  2004. deprecated="not deprecated">
  2005. </field>
  2006. <field name="FAILED" type="org.apache.hadoop.mapred.JobClient.TaskStatusFilter"
  2007. transient="false" volatile="false"
  2008. static="true" final="true" visibility="public"
  2009. deprecated="not deprecated">
  2010. </field>
  2011. <field name="SUCCEEDED" type="org.apache.hadoop.mapred.JobClient.TaskStatusFilter"
  2012. transient="false" volatile="false"
  2013. static="true" final="true" visibility="public"
  2014. deprecated="not deprecated">
  2015. </field>
  2016. <field name="ALL" type="org.apache.hadoop.mapred.JobClient.TaskStatusFilter"
  2017. transient="false" volatile="false"
  2018. static="true" final="true" visibility="public"
  2019. deprecated="not deprecated">
  2020. </field>
  2021. </class>
  2022. <!-- end class org.apache.hadoop.mapred.JobClient.TaskStatusFilter -->
  2023. <!-- start class org.apache.hadoop.mapred.JobConf -->
  2024. <class name="JobConf" extends="org.apache.hadoop.conf.Configuration"
  2025. abstract="false"
  2026. static="false" final="false" visibility="public"
  2027. deprecated="Use {@link Configuration} instead">
  2028. <constructor name="JobConf"
  2029. static="false" final="false" visibility="public"
  2030. deprecated="not deprecated">
  2031. <doc>
  2032. <![CDATA[Construct a map/reduce job configuration.]]>
  2033. </doc>
  2034. </constructor>
  2035. <constructor name="JobConf" type="java.lang.Class"
  2036. static="false" final="false" visibility="public"
  2037. deprecated="not deprecated">
  2038. <doc>
  2039. <![CDATA[Construct a map/reduce job configuration.
  2040. @param exampleClass a class whose containing jar is used as the job's jar.]]>
  2041. </doc>
  2042. </constructor>
  2043. <constructor name="JobConf" type="org.apache.hadoop.conf.Configuration"
  2044. static="false" final="false" visibility="public"
  2045. deprecated="not deprecated">
  2046. <doc>
  2047. <![CDATA[Construct a map/reduce job configuration.
  2048. @param conf a Configuration whose settings will be inherited.]]>
  2049. </doc>
  2050. </constructor>
  2051. <constructor name="JobConf" type="org.apache.hadoop.conf.Configuration, java.lang.Class"
  2052. static="false" final="false" visibility="public"
  2053. deprecated="not deprecated">
  2054. <doc>
  2055. <![CDATA[Construct a map/reduce job configuration.
  2056. @param conf a Configuration whose settings will be inherited.
  2057. @param exampleClass a class whose containing jar is used as the job's jar.]]>
  2058. </doc>
  2059. </constructor>
  2060. <constructor name="JobConf" type="java.lang.String"
  2061. static="false" final="false" visibility="public"
  2062. deprecated="not deprecated">
  2063. <doc>
  2064. <![CDATA[Construct a map/reduce configuration.
  2065. @param config a Configuration-format XML job description file.]]>
  2066. </doc>
  2067. </constructor>
  2068. <constructor name="JobConf" type="org.apache.hadoop.fs.Path"
  2069. static="false" final="false" visibility="public"
  2070. deprecated="not deprecated">
  2071. <doc>
  2072. <![CDATA[Construct a map/reduce configuration.
  2073. @param config a Configuration-format XML job description file.]]>
  2074. </doc>
  2075. </constructor>
  2076. <constructor name="JobConf" type="boolean"
  2077. static="false" final="false" visibility="public"
  2078. deprecated="not deprecated">
  2079. <doc>
  2080. <![CDATA[A new map/reduce configuration where the behavior of reading from the
  2081. default resources can be turned off.
  2082. <p/>
  2083. If the parameter {@code loadDefaults} is false, the new instance
  2084. will not load resources from the default files.
  2085. @param loadDefaults specifies whether to load from the default files]]>
  2086. </doc>
  2087. </constructor>
  2088. <method name="getJar" return="java.lang.String"
  2089. abstract="false" native="false" synchronized="false"
  2090. static="false" final="false" visibility="public"
  2091. deprecated="not deprecated">
  2092. <doc>
  2093. <![CDATA[Get the user jar for the map-reduce job.
  2094. @return the user jar for the map-reduce job.]]>
  2095. </doc>
  2096. </method>
  2097. <method name="setJar"
  2098. abstract="false" native="false" synchronized="false"
  2099. static="false" final="false" visibility="public"
  2100. deprecated="not deprecated">
  2101. <param name="jar" type="java.lang.String"/>
  2102. <doc>
  2103. <![CDATA[Set the user jar for the map-reduce job.
  2104. @param jar the user jar for the map-reduce job.]]>
  2105. </doc>
  2106. </method>
  2107. <method name="setJarByClass"
  2108. abstract="false" native="false" synchronized="false"
  2109. static="false" final="false" visibility="public"
  2110. deprecated="not deprecated">
  2111. <param name="cls" type="java.lang.Class"/>
  2112. <doc>
  2113. <![CDATA[Set the job's jar file by finding an example class location.
  2114. @param cls the example class.]]>
  2115. </doc>
  2116. </method>
  2117. <method name="getLocalDirs" return="java.lang.String[]"
  2118. abstract="false" native="false" synchronized="false"
  2119. static="false" final="false" visibility="public"
  2120. deprecated="not deprecated">
  2121. <exception name="IOException" type="java.io.IOException"/>
  2122. </method>
  2123. <method name="deleteLocalFiles"
  2124. abstract="false" native="false" synchronized="false"
  2125. static="false" final="false" visibility="public"
  2126. deprecated="not deprecated">
  2127. <exception name="IOException" type="java.io.IOException"/>
  2128. </method>
  2129. <method name="deleteLocalFiles"
  2130. abstract="false" native="false" synchronized="false"
  2131. static="false" final="false" visibility="public"
  2132. deprecated="not deprecated">
  2133. <param name="subdir" type="java.lang.String"/>
  2134. <exception name="IOException" type="java.io.IOException"/>
  2135. </method>
  2136. <method name="getLocalPath" return="org.apache.hadoop.fs.Path"
  2137. abstract="false" native="false" synchronized="false"
  2138. static="false" final="false" visibility="public"
  2139. deprecated="not deprecated">
  2140. <param name="pathString" type="java.lang.String"/>
  2141. <exception name="IOException" type="java.io.IOException"/>
  2142. <doc>
  2143. <![CDATA[Constructs a local file name. Files are distributed among configured
  2144. local directories.]]>
  2145. </doc>
  2146. </method>
  2147. <method name="getUser" return="java.lang.String"
  2148. abstract="false" native="false" synchronized="false"
  2149. static="false" final="false" visibility="public"
  2150. deprecated="not deprecated">
  2151. <doc>
  2152. <![CDATA[Get the reported username for this job.
  2153. @return the username]]>
  2154. </doc>
  2155. </method>
  2156. <method name="setUser"
  2157. abstract="false" native="false" synchronized="false"
  2158. static="false" final="false" visibility="public"
  2159. deprecated="not deprecated">
  2160. <param name="user" type="java.lang.String"/>
  2161. <doc>
  2162. <![CDATA[Set the reported username for this job.
  2163. @param user the username for this job.]]>
  2164. </doc>
  2165. </method>
  2166. <method name="setKeepFailedTaskFiles"
  2167. abstract="false" native="false" synchronized="false"
  2168. static="false" final="false" visibility="public"
  2169. deprecated="not deprecated">
  2170. <param name="keep" type="boolean"/>
  2171. <doc>
  2172. <![CDATA[Set whether the framework should keep the intermediate files for
  2173. failed tasks.
  2174. @param keep <code>true</code> if framework should keep the intermediate files
  2175. for failed tasks, <code>false</code> otherwise.]]>
  2176. </doc>
  2177. </method>
  2178. <method name="getKeepFailedTaskFiles" return="boolean"
  2179. abstract="false" native="false" synchronized="false"
  2180. static="false" final="false" visibility="public"
  2181. deprecated="not deprecated">
  2182. <doc>
  2183. <![CDATA[Should the temporary files for failed tasks be kept?
  2184. @return should the files be kept?]]>
  2185. </doc>
  2186. </method>
  2187. <method name="setKeepTaskFilesPattern"
  2188. abstract="false" native="false" synchronized="false"
  2189. static="false" final="false" visibility="public"
  2190. deprecated="not deprecated">
  2191. <param name="pattern" type="java.lang.String"/>
  2192. <doc>
  2193. <![CDATA[Set a regular expression for task names that should be kept.
  2194. The regular expression ".*_m_000123_0" would keep the files
  2195. for the first instance of map 123 that ran.
  2196. @param pattern the java.util.regex.Pattern to match against the
  2197. task names.]]>
  2198. </doc>
  2199. </method>
  2200. <method name="getKeepTaskFilesPattern" return="java.lang.String"
  2201. abstract="false" native="false" synchronized="false"
  2202. static="false" final="false" visibility="public"
  2203. deprecated="not deprecated">
  2204. <doc>
  2205. <![CDATA[Get the regular expression that is matched against the task names
  2206. to see if we need to keep the files.
  2207. @return the pattern as a string, if it was set, othewise null.]]>
  2208. </doc>
  2209. </method>
  2210. <method name="setWorkingDirectory"
  2211. abstract="false" native="false" synchronized="false"
  2212. static="false" final="false" visibility="public"
  2213. deprecated="not deprecated">
  2214. <param name="dir" type="org.apache.hadoop.fs.Path"/>
  2215. <doc>
  2216. <![CDATA[Set the current working directory for the default file system.
  2217. @param dir the new current working directory.]]>
  2218. </doc>
  2219. </method>
  2220. <method name="getWorkingDirectory" return="org.apache.hadoop.fs.Path"
  2221. abstract="false" native="false" synchronized="false"
  2222. static="false" final="false" visibility="public"
  2223. deprecated="not deprecated">
  2224. <doc>
  2225. <![CDATA[Get the current working directory for the default file system.
  2226. @return the directory name.]]>
  2227. </doc>
  2228. </method>
  2229. <method name="setNumTasksToExecutePerJvm"
  2230. abstract="false" native="false" synchronized="false"
  2231. static="false" final="false" visibility="public"
  2232. deprecated="not deprecated">
  2233. <param name="numTasks" type="int"/>
  2234. <doc>
  2235. <![CDATA[Sets the number of tasks that a spawned task JVM should run
  2236. before it exits
  2237. @param numTasks the number of tasks to execute; defaults to 1;
  2238. -1 signifies no limit]]>
  2239. </doc>
  2240. </method>
  2241. <method name="getNumTasksToExecutePerJvm" return="int"
  2242. abstract="false" native="false" synchronized="false"
  2243. static="false" final="false" visibility="public"
  2244. deprecated="not deprecated">
  2245. <doc>
  2246. <![CDATA[Get the number of tasks that a spawned JVM should execute]]>
  2247. </doc>
  2248. </method>
  2249. <method name="getInputFormat" return="org.apache.hadoop.mapred.InputFormat"
  2250. abstract="false" native="false" synchronized="false"
  2251. static="false" final="false" visibility="public"
  2252. deprecated="not deprecated">
  2253. <doc>
  2254. <![CDATA[Get the {@link InputFormat} implementation for the map-reduce job,
  2255. defaults to {@link TextInputFormat} if not specified explicity.
  2256. @return the {@link InputFormat} implementation for the map-reduce job.]]>
  2257. </doc>
  2258. </method>
  2259. <method name="setInputFormat"
  2260. abstract="false" native="false" synchronized="false"
  2261. static="false" final="false" visibility="public"
  2262. deprecated="not deprecated">
  2263. <param name="theClass" type="java.lang.Class"/>
  2264. <doc>
  2265. <![CDATA[Set the {@link InputFormat} implementation for the map-reduce job.
  2266. @param theClass the {@link InputFormat} implementation for the map-reduce
  2267. job.]]>
  2268. </doc>
  2269. </method>
  2270. <method name="getOutputFormat" return="org.apache.hadoop.mapred.OutputFormat"
  2271. abstract="false" native="false" synchronized="false"
  2272. static="false" final="false" visibility="public"
  2273. deprecated="not deprecated">
  2274. <doc>
  2275. <![CDATA[Get the {@link OutputFormat} implementation for the map-reduce job,
  2276. defaults to {@link TextOutputFormat} if not specified explicity.
  2277. @return the {@link OutputFormat} implementation for the map-reduce job.]]>
  2278. </doc>
  2279. </method>
  2280. <method name="getOutputCommitter" return="org.apache.hadoop.mapred.OutputCommitter"
  2281. abstract="false" native="false" synchronized="false"
  2282. static="false" final="false" visibility="public"
  2283. deprecated="not deprecated">
  2284. <doc>
  2285. <![CDATA[Get the {@link OutputCommitter} implementation for the map-reduce job,
  2286. defaults to {@link FileOutputCommitter} if not specified explicitly.
  2287. @return the {@link OutputCommitter} implementation for the map-reduce job.]]>
  2288. </doc>
  2289. </method>
  2290. <method name="setOutputCommitter"
  2291. abstract="false" native="false" synchronized="false"
  2292. static="false" final="false" visibility="public"
  2293. deprecated="not deprecated">
  2294. <param name="theClass" type="java.lang.Class"/>
  2295. <doc>
  2296. <![CDATA[Set the {@link OutputCommitter} implementation for the map-reduce job.
  2297. @param theClass the {@link OutputCommitter} implementation for the map-reduce
  2298. job.]]>
  2299. </doc>
  2300. </method>
  2301. <method name="setOutputFormat"
  2302. abstract="false" native="false" synchronized="false"
  2303. static="false" final="false" visibility="public"
  2304. deprecated="not deprecated">
  2305. <param name="theClass" type="java.lang.Class"/>
  2306. <doc>
  2307. <![CDATA[Set the {@link OutputFormat} implementation for the map-reduce job.
  2308. @param theClass the {@link OutputFormat} implementation for the map-reduce
  2309. job.]]>
  2310. </doc>
  2311. </method>
  2312. <method name="setCompressMapOutput"
  2313. abstract="false" native="false" synchronized="false"
  2314. static="false" final="false" visibility="public"
  2315. deprecated="not deprecated">
  2316. <param name="compress" type="boolean"/>
  2317. <doc>
  2318. <![CDATA[Should the map outputs be compressed before transfer?
  2319. Uses the SequenceFile compression.
  2320. @param compress should the map outputs be compressed?]]>
  2321. </doc>
  2322. </method>
  2323. <method name="getCompressMapOutput" return="boolean"
  2324. abstract="false" native="false" synchronized="false"
  2325. static="false" final="false" visibility="public"
  2326. deprecated="not deprecated">
  2327. <doc>
  2328. <![CDATA[Are the outputs of the maps be compressed?
  2329. @return <code>true</code> if the outputs of the maps are to be compressed,
  2330. <code>false</code> otherwise.]]>
  2331. </doc>
  2332. </method>
  2333. <method name="setMapOutputCompressorClass"
  2334. abstract="false" native="false" synchronized="false"
  2335. static="false" final="false" visibility="public"
  2336. deprecated="not deprecated">
  2337. <param name="codecClass" type="java.lang.Class"/>
  2338. <doc>
  2339. <![CDATA[Set the given class as the {@link CompressionCodec} for the map outputs.
  2340. @param codecClass the {@link CompressionCodec} class that will compress
  2341. the map outputs.]]>
  2342. </doc>
  2343. </method>
  2344. <method name="getMapOutputCompressorClass" return="java.lang.Class"
  2345. abstract="false" native="false" synchronized="false"
  2346. static="false" final="false" visibility="public"
  2347. deprecated="not deprecated">
  2348. <param name="defaultValue" type="java.lang.Class"/>
  2349. <doc>
  2350. <![CDATA[Get the {@link CompressionCodec} for compressing the map outputs.
  2351. @param defaultValue the {@link CompressionCodec} to return if not set
  2352. @return the {@link CompressionCodec} class that should be used to compress the
  2353. map outputs.
  2354. @throws IllegalArgumentException if the class was specified, but not found]]>
  2355. </doc>
  2356. </method>
  2357. <method name="getMapOutputKeyClass" return="java.lang.Class"
  2358. abstract="false" native="false" synchronized="false"
  2359. static="false" final="false" visibility="public"
  2360. deprecated="not deprecated">
  2361. <doc>
  2362. <![CDATA[Get the key class for the map output data. If it is not set, use the
  2363. (final) output key class. This allows the map output key class to be
  2364. different than the final output key class.
  2365. @return the map output key class.]]>
  2366. </doc>
  2367. </method>
  2368. <method name="setMapOutputKeyClass"
  2369. abstract="false" native="false" synchronized="false"
  2370. static="false" final="false" visibility="public"
  2371. deprecated="not deprecated">
  2372. <param name="theClass" type="java.lang.Class"/>
  2373. <doc>
  2374. <![CDATA[Set the key class for the map output data. This allows the user to
  2375. specify the map output key class to be different than the final output
  2376. value class.
  2377. @param theClass the map output key class.]]>
  2378. </doc>
  2379. </method>
  2380. <method name="getMapOutputValueClass" return="java.lang.Class"
  2381. abstract="false" native="false" synchronized="false"
  2382. static="false" final="false" visibility="public"
  2383. deprecated="not deprecated">
  2384. <doc>
  2385. <![CDATA[Get the value class for the map output data. If it is not set, use the
  2386. (final) output value class This allows the map output value class to be
  2387. different than the final output value class.
  2388. @return the map output value class.]]>
  2389. </doc>
  2390. </method>
  2391. <method name="setMapOutputValueClass"
  2392. abstract="false" native="false" synchronized="false"
  2393. static="false" final="false" visibility="public"
  2394. deprecated="not deprecated">
  2395. <param name="theClass" type="java.lang.Class"/>
  2396. <doc>
  2397. <![CDATA[Set the value class for the map output data. This allows the user to
  2398. specify the map output value class to be different than the final output
  2399. value class.
  2400. @param theClass the map output value class.]]>
  2401. </doc>
  2402. </method>
  2403. <method name="getOutputKeyClass" return="java.lang.Class"
  2404. abstract="false" native="false" synchronized="false"
  2405. static="false" final="false" visibility="public"
  2406. deprecated="not deprecated">
  2407. <doc>
  2408. <![CDATA[Get the key class for the job output data.
  2409. @return the key class for the job output data.]]>
  2410. </doc>
  2411. </method>
  2412. <method name="setOutputKeyClass"
  2413. abstract="false" native="false" synchronized="false"
  2414. static="false" final="false" visibility="public"
  2415. deprecated="not deprecated">
  2416. <param name="theClass" type="java.lang.Class"/>
  2417. <doc>
  2418. <![CDATA[Set the key class for the job output data.
  2419. @param theClass the key class for the job output data.]]>
  2420. </doc>
  2421. </method>
  2422. <method name="getOutputKeyComparator" return="org.apache.hadoop.io.RawComparator"
  2423. abstract="false" native="false" synchronized="false"
  2424. static="false" final="false" visibility="public"
  2425. deprecated="not deprecated">
  2426. <doc>
  2427. <![CDATA[Get the {@link RawComparator} comparator used to compare keys.
  2428. @return the {@link RawComparator} comparator used to compare keys.]]>
  2429. </doc>
  2430. </method>
  2431. <method name="setOutputKeyComparatorClass"
  2432. abstract="false" native="false" synchronized="false"
  2433. static="false" final="false" visibility="public"
  2434. deprecated="not deprecated">
  2435. <param name="theClass" type="java.lang.Class"/>
  2436. <doc>
  2437. <![CDATA[Set the {@link RawComparator} comparator used to compare keys.
  2438. @param theClass the {@link RawComparator} comparator used to
  2439. compare keys.
  2440. @see #setOutputValueGroupingComparator(Class)]]>
  2441. </doc>
  2442. </method>
  2443. <method name="setKeyFieldComparatorOptions"
  2444. abstract="false" native="false" synchronized="false"
  2445. static="false" final="false" visibility="public"
  2446. deprecated="not deprecated">
  2447. <param name="keySpec" type="java.lang.String"/>
  2448. <doc>
  2449. <![CDATA[Set the {@link KeyFieldBasedComparator} options used to compare keys.
  2450. @param keySpec the key specification of the form -k pos1[,pos2], where,
  2451. pos is of the form f[.c][opts], where f is the number
  2452. of the key field to use, and c is the number of the first character from
  2453. the beginning of the field. Fields and character posns are numbered
  2454. starting with 1; a character position of zero in pos2 indicates the
  2455. field's last character. If '.c' is omitted from pos1, it defaults to 1
  2456. (the beginning of the field); if omitted from pos2, it defaults to 0
  2457. (the end of the field). opts are ordering options. The supported options
  2458. are:
  2459. -n, (Sort numerically)
  2460. -r, (Reverse the result of comparison)]]>
  2461. </doc>
  2462. </method>
  2463. <method name="getKeyFieldComparatorOption" return="java.lang.String"
  2464. abstract="false" native="false" synchronized="false"
  2465. static="false" final="false" visibility="public"
  2466. deprecated="not deprecated">
  2467. <doc>
  2468. <![CDATA[Get the {@link KeyFieldBasedComparator} options]]>
  2469. </doc>
  2470. </method>
  2471. <method name="setKeyFieldPartitionerOptions"
  2472. abstract="false" native="false" synchronized="false"
  2473. static="false" final="false" visibility="public"
  2474. deprecated="not deprecated">
  2475. <param name="keySpec" type="java.lang.String"/>
  2476. <doc>
  2477. <![CDATA[Set the {@link KeyFieldBasedPartitioner} options used for
  2478. {@link Partitioner}
  2479. @param keySpec the key specification of the form -k pos1[,pos2], where,
  2480. pos is of the form f[.c][opts], where f is the number
  2481. of the key field to use, and c is the number of the first character from
  2482. the beginning of the field. Fields and character posns are numbered
  2483. starting with 1; a character position of zero in pos2 indicates the
  2484. field's last character. If '.c' is omitted from pos1, it defaults to 1
  2485. (the beginning of the field); if omitted from pos2, it defaults to 0
  2486. (the end of the field).]]>
  2487. </doc>
  2488. </method>
  2489. <method name="getKeyFieldPartitionerOption" return="java.lang.String"
  2490. abstract="false" native="false" synchronized="false"
  2491. static="false" final="false" visibility="public"
  2492. deprecated="not deprecated">
  2493. <doc>
  2494. <![CDATA[Get the {@link KeyFieldBasedPartitioner} options]]>
  2495. </doc>
  2496. </method>
  2497. <method name="getOutputValueGroupingComparator" return="org.apache.hadoop.io.RawComparator"
  2498. abstract="false" native="false" synchronized="false"
  2499. static="false" final="false" visibility="public"
  2500. deprecated="not deprecated">
  2501. <doc>
  2502. <![CDATA[Get the user defined {@link WritableComparable} comparator for
  2503. grouping keys of inputs to the reduce.
  2504. @return comparator set by the user for grouping values.
  2505. @see #setOutputValueGroupingComparator(Class) for details.]]>
  2506. </doc>
  2507. </method>
  2508. <method name="setOutputValueGroupingComparator"
  2509. abstract="false" native="false" synchronized="false"
  2510. static="false" final="false" visibility="public"
  2511. deprecated="not deprecated">
  2512. <param name="theClass" type="java.lang.Class"/>
  2513. <doc>
  2514. <![CDATA[Set the user defined {@link RawComparator} comparator for
  2515. grouping keys in the input to the reduce.
  2516. <p>This comparator should be provided if the equivalence rules for keys
  2517. for sorting the intermediates are different from those for grouping keys
  2518. before each call to
  2519. {@link Reducer#reduce(Object, java.util.Iterator, OutputCollector, Reporter)}.</p>
  2520. <p>For key-value pairs (K1,V1) and (K2,V2), the values (V1, V2) are passed
  2521. in a single call to the reduce function if K1 and K2 compare as equal.</p>
  2522. <p>Since {@link #setOutputKeyComparatorClass(Class)} can be used to control
  2523. how keys are sorted, this can be used in conjunction to simulate
  2524. <i>secondary sort on values</i>.</p>
  2525. <p><i>Note</i>: This is not a guarantee of the reduce sort being
  2526. <i>stable</i> in any sense. (In any case, with the order of available
  2527. map-outputs to the reduce being non-deterministic, it wouldn't make
  2528. that much sense.)</p>
  2529. @param theClass the comparator class to be used for grouping keys.
  2530. It should implement <code>RawComparator</code>.
  2531. @see #setOutputKeyComparatorClass(Class)]]>
  2532. </doc>
  2533. </method>
  2534. <method name="getUseNewMapper" return="boolean"
  2535. abstract="false" native="false" synchronized="false"
  2536. static="false" final="false" visibility="public"
  2537. deprecated="not deprecated">
  2538. <doc>
  2539. <![CDATA[Should the framework use the new context-object code for running
  2540. the mapper?
  2541. @return true, if the new api should be used]]>
  2542. </doc>
  2543. </method>
  2544. <method name="setUseNewMapper"
  2545. abstract="false" native="false" synchronized="false"
  2546. static="false" final="false" visibility="public"
  2547. deprecated="not deprecated">
  2548. <param name="flag" type="boolean"/>
  2549. <doc>
  2550. <![CDATA[Set whether the framework should use the new api for the mapper.
  2551. This is the default for jobs submitted with the new Job api.
  2552. @param flag true, if the new api should be used]]>
  2553. </doc>
  2554. </method>
  2555. <method name="getUseNewReducer" return="boolean"
  2556. abstract="false" native="false" synchronized="false"
  2557. static="false" final="false" visibility="public"
  2558. deprecated="not deprecated">
  2559. <doc>
  2560. <![CDATA[Should the framework use the new context-object code for running
  2561. the reducer?
  2562. @return true, if the new api should be used]]>
  2563. </doc>
  2564. </method>
  2565. <method name="setUseNewReducer"
  2566. abstract="false" native="false" synchronized="false"
  2567. static="false" final="false" visibility="public"
  2568. deprecated="not deprecated">
  2569. <param name="flag" type="boolean"/>
  2570. <doc>
  2571. <![CDATA[Set whether the framework should use the new api for the reducer.
  2572. This is the default for jobs submitted with the new Job api.
  2573. @param flag true, if the new api should be used]]>
  2574. </doc>
  2575. </method>
  2576. <method name="getOutputValueClass" return="java.lang.Class"
  2577. abstract="false" native="false" synchronized="false"
  2578. static="false" final="false" visibility="public"
  2579. deprecated="not deprecated">
  2580. <doc>
  2581. <![CDATA[Get the value class for job outputs.
  2582. @return the value class for job outputs.]]>
  2583. </doc>
  2584. </method>
  2585. <method name="setOutputValueClass"
  2586. abstract="false" native="false" synchronized="false"
  2587. static="false" final="false" visibility="public"
  2588. deprecated="not deprecated">
  2589. <param name="theClass" type="java.lang.Class"/>
  2590. <doc>
  2591. <![CDATA[Set the value class for job outputs.
  2592. @param theClass the value class for job outputs.]]>
  2593. </doc>
  2594. </method>
  2595. <method name="getMapperClass" return="java.lang.Class"
  2596. abstract="false" native="false" synchronized="false"
  2597. static="false" final="false" visibility="public"
  2598. deprecated="not deprecated">
  2599. <doc>
  2600. <![CDATA[Get the {@link Mapper} class for the job.
  2601. @return the {@link Mapper} class for the job.]]>
  2602. </doc>
  2603. </method>
  2604. <method name="setMapperClass"
  2605. abstract="false" native="false" synchronized="false"
  2606. static="false" final="false" visibility="public"
  2607. deprecated="not deprecated">
  2608. <param name="theClass" type="java.lang.Class"/>
  2609. <doc>
  2610. <![CDATA[Set the {@link Mapper} class for the job.
  2611. @param theClass the {@link Mapper} class for the job.]]>
  2612. </doc>
  2613. </method>
  2614. <method name="getMapRunnerClass" return="java.lang.Class"
  2615. abstract="false" native="false" synchronized="false"
  2616. static="false" final="false" visibility="public"
  2617. deprecated="not deprecated">
  2618. <doc>
  2619. <![CDATA[Get the {@link MapRunnable} class for the job.
  2620. @return the {@link MapRunnable} class for the job.]]>
  2621. </doc>
  2622. </method>
  2623. <method name="setMapRunnerClass"
  2624. abstract="false" native="false" synchronized="false"
  2625. static="false" final="false" visibility="public"
  2626. deprecated="not deprecated">
  2627. <param name="theClass" type="java.lang.Class"/>
  2628. <doc>
  2629. <![CDATA[Expert: Set the {@link MapRunnable} class for the job.
  2630. Typically used to exert greater control on {@link Mapper}s.
  2631. @param theClass the {@link MapRunnable} class for the job.]]>
  2632. </doc>
  2633. </method>
  2634. <method name="getPartitionerClass" return="java.lang.Class"
  2635. abstract="false" native="false" synchronized="false"
  2636. static="false" final="false" visibility="public"
  2637. deprecated="not deprecated">
  2638. <doc>
  2639. <![CDATA[Get the {@link Partitioner} used to partition {@link Mapper}-outputs
  2640. to be sent to the {@link Reducer}s.
  2641. @return the {@link Partitioner} used to partition map-outputs.]]>
  2642. </doc>
  2643. </method>
  2644. <method name="setPartitionerClass"
  2645. abstract="false" native="false" synchronized="false"
  2646. static="false" final="false" visibility="public"
  2647. deprecated="not deprecated">
  2648. <param name="theClass" type="java.lang.Class"/>
  2649. <doc>
  2650. <![CDATA[Set the {@link Partitioner} class used to partition
  2651. {@link Mapper}-outputs to be sent to the {@link Reducer}s.
  2652. @param theClass the {@link Partitioner} used to partition map-outputs.]]>
  2653. </doc>
  2654. </method>
  2655. <method name="getReducerClass" return="java.lang.Class"
  2656. abstract="false" native="false" synchronized="false"
  2657. static="false" final="false" visibility="public"
  2658. deprecated="not deprecated">
  2659. <doc>
  2660. <![CDATA[Get the {@link Reducer} class for the job.
  2661. @return the {@link Reducer} class for the job.]]>
  2662. </doc>
  2663. </method>
  2664. <method name="setReducerClass"
  2665. abstract="false" native="false" synchronized="false"
  2666. static="false" final="false" visibility="public"
  2667. deprecated="not deprecated">
  2668. <param name="theClass" type="java.lang.Class"/>
  2669. <doc>
  2670. <![CDATA[Set the {@link Reducer} class for the job.
  2671. @param theClass the {@link Reducer} class for the job.]]>
  2672. </doc>
  2673. </method>
  2674. <method name="getCombinerClass" return="java.lang.Class"
  2675. abstract="false" native="false" synchronized="false"
  2676. static="false" final="false" visibility="public"
  2677. deprecated="not deprecated">
  2678. <doc>
  2679. <![CDATA[Get the user-defined <i>combiner</i> class used to combine map-outputs
  2680. before being sent to the reducers. Typically the combiner is same as the
  2681. the {@link Reducer} for the job i.e. {@link #getReducerClass()}.
  2682. @return the user-defined combiner class used to combine map-outputs.]]>
  2683. </doc>
  2684. </method>
  2685. <method name="setCombinerClass"
  2686. abstract="false" native="false" synchronized="false"
  2687. static="false" final="false" visibility="public"
  2688. deprecated="not deprecated">
  2689. <param name="theClass" type="java.lang.Class"/>
  2690. <doc>
  2691. <![CDATA[Set the user-defined <i>combiner</i> class used to combine map-outputs
  2692. before being sent to the reducers.
  2693. <p>The combiner is an application-specified aggregation operation, which
  2694. can help cut down the amount of data transferred between the
  2695. {@link Mapper} and the {@link Reducer}, leading to better performance.</p>
  2696. <p>The framework may invoke the combiner 0, 1, or multiple times, in both
  2697. the mapper and reducer tasks. In general, the combiner is called as the
  2698. sort/merge result is written to disk. The combiner must:
  2699. <ul>
  2700. <li> be side-effect free</li>
  2701. <li> have the same input and output key types and the same input and
  2702. output value types</li>
  2703. </ul></p>
  2704. <p>Typically the combiner is same as the <code>Reducer</code> for the
  2705. job i.e. {@link #setReducerClass(Class)}.</p>
  2706. @param theClass the user-defined combiner class used to combine
  2707. map-outputs.]]>
  2708. </doc>
  2709. </method>
  2710. <method name="getSpeculativeExecution" return="boolean"
  2711. abstract="false" native="false" synchronized="false"
  2712. static="false" final="false" visibility="public"
  2713. deprecated="not deprecated">
  2714. <doc>
  2715. <![CDATA[Should speculative execution be used for this job?
  2716. Defaults to <code>true</code>.
  2717. @return <code>true</code> if speculative execution be used for this job,
  2718. <code>false</code> otherwise.]]>
  2719. </doc>
  2720. </method>
  2721. <method name="setSpeculativeExecution"
  2722. abstract="false" native="false" synchronized="false"
  2723. static="false" final="false" visibility="public"
  2724. deprecated="not deprecated">
  2725. <param name="speculativeExecution" type="boolean"/>
  2726. <doc>
  2727. <![CDATA[Turn speculative execution on or off for this job.
  2728. @param speculativeExecution <code>true</code> if speculative execution
  2729. should be turned on, else <code>false</code>.]]>
  2730. </doc>
  2731. </method>
  2732. <method name="getMapSpeculativeExecution" return="boolean"
  2733. abstract="false" native="false" synchronized="false"
  2734. static="false" final="false" visibility="public"
  2735. deprecated="not deprecated">
  2736. <doc>
  2737. <![CDATA[Should speculative execution be used for this job for map tasks?
  2738. Defaults to <code>true</code>.
  2739. @return <code>true</code> if speculative execution be
  2740. used for this job for map tasks,
  2741. <code>false</code> otherwise.]]>
  2742. </doc>
  2743. </method>
  2744. <method name="setMapSpeculativeExecution"
  2745. abstract="false" native="false" synchronized="false"
  2746. static="false" final="false" visibility="public"
  2747. deprecated="not deprecated">
  2748. <param name="speculativeExecution" type="boolean"/>
  2749. <doc>
  2750. <![CDATA[Turn speculative execution on or off for this job for map tasks.
  2751. @param speculativeExecution <code>true</code> if speculative execution
  2752. should be turned on for map tasks,
  2753. else <code>false</code>.]]>
  2754. </doc>
  2755. </method>
  2756. <method name="getReduceSpeculativeExecution" return="boolean"
  2757. abstract="false" native="false" synchronized="false"
  2758. static="false" final="false" visibility="public"
  2759. deprecated="not deprecated">
  2760. <doc>
  2761. <![CDATA[Should speculative execution be used for this job for reduce tasks?
  2762. Defaults to <code>true</code>.
  2763. @return <code>true</code> if speculative execution be used
  2764. for reduce tasks for this job,
  2765. <code>false</code> otherwise.]]>
  2766. </doc>
  2767. </method>
  2768. <method name="setReduceSpeculativeExecution"
  2769. abstract="false" native="false" synchronized="false"
  2770. static="false" final="false" visibility="public"
  2771. deprecated="not deprecated">
  2772. <param name="speculativeExecution" type="boolean"/>
  2773. <doc>
  2774. <![CDATA[Turn speculative execution on or off for this job for reduce tasks.
  2775. @param speculativeExecution <code>true</code> if speculative execution
  2776. should be turned on for reduce tasks,
  2777. else <code>false</code>.]]>
  2778. </doc>
  2779. </method>
  2780. <method name="getNumMapTasks" return="int"
  2781. abstract="false" native="false" synchronized="false"
  2782. static="false" final="false" visibility="public"
  2783. deprecated="not deprecated">
  2784. <doc>
  2785. <![CDATA[Get configured the number of reduce tasks for this job.
  2786. Defaults to <code>1</code>.
  2787. @return the number of reduce tasks for this job.]]>
  2788. </doc>
  2789. </method>
  2790. <method name="setNumMapTasks"
  2791. abstract="false" native="false" synchronized="false"
  2792. static="false" final="false" visibility="public"
  2793. deprecated="not deprecated">
  2794. <param name="n" type="int"/>
  2795. <doc>
  2796. <![CDATA[Set the number of map tasks for this job.
  2797. <p><i>Note</i>: This is only a <i>hint</i> to the framework. The actual
  2798. number of spawned map tasks depends on the number of {@link InputSplit}s
  2799. generated by the job's {@link InputFormat#getSplits(JobConf, int)}.
  2800. A custom {@link InputFormat} is typically used to accurately control
  2801. the number of map tasks for the job.</p>
  2802. <h4 id="NoOfMaps">How many maps?</h4>
  2803. <p>The number of maps is usually driven by the total size of the inputs
  2804. i.e. total number of blocks of the input files.</p>
  2805. <p>The right level of parallelism for maps seems to be around 10-100 maps
  2806. per-node, although it has been set up to 300 or so for very cpu-light map
  2807. tasks. Task setup takes awhile, so it is best if the maps take at least a
  2808. minute to execute.</p>
  2809. <p>The default behavior of file-based {@link InputFormat}s is to split the
  2810. input into <i>logical</i> {@link InputSplit}s based on the total size, in
  2811. bytes, of input files. However, the {@link FileSystem} blocksize of the
  2812. input files is treated as an upper bound for input splits. A lower bound
  2813. on the split size can be set via
  2814. <a href="{@docRoot}/../mapred-default.html#mapred.min.split.size">
  2815. mapred.min.split.size</a>.</p>
  2816. <p>Thus, if you expect 10TB of input data and have a blocksize of 128MB,
  2817. you'll end up with 82,000 maps, unless {@link #setNumMapTasks(int)} is
  2818. used to set it even higher.</p>
  2819. @param n the number of map tasks for this job.
  2820. @see InputFormat#getSplits(JobConf, int)
  2821. @see FileInputFormat
  2822. @see FileSystem#getDefaultBlockSize()
  2823. @see FileStatus#getBlockSize()]]>
  2824. </doc>
  2825. </method>
  2826. <method name="getNumReduceTasks" return="int"
  2827. abstract="false" native="false" synchronized="false"
  2828. static="false" final="false" visibility="public"
  2829. deprecated="not deprecated">
  2830. <doc>
  2831. <![CDATA[Get configured the number of reduce tasks for this job. Defaults to
  2832. <code>1</code>.
  2833. @return the number of reduce tasks for this job.]]>
  2834. </doc>
  2835. </method>
  2836. <method name="setNumReduceTasks"
  2837. abstract="false" native="false" synchronized="false"
  2838. static="false" final="false" visibility="public"
  2839. deprecated="not deprecated">
  2840. <param name="n" type="int"/>
  2841. <doc>
  2842. <![CDATA[Set the requisite number of reduce tasks for this job.
  2843. <h4 id="NoOfReduces">How many reduces?</h4>
  2844. <p>The right number of reduces seems to be <code>0.95</code> or
  2845. <code>1.75</code> multiplied by (&lt;<i>no. of nodes</i>&gt; *
  2846. <a href="{@docRoot}/../mapred-default.html#mapred.tasktracker.reduce.tasks.maximum">
  2847. mapred.tasktracker.reduce.tasks.maximum</a>).
  2848. </p>
  2849. <p>With <code>0.95</code> all of the reduces can launch immediately and
  2850. start transfering map outputs as the maps finish. With <code>1.75</code>
  2851. the faster nodes will finish their first round of reduces and launch a
  2852. second wave of reduces doing a much better job of load balancing.</p>
  2853. <p>Increasing the number of reduces increases the framework overhead, but
  2854. increases load balancing and lowers the cost of failures.</p>
  2855. <p>The scaling factors above are slightly less than whole numbers to
  2856. reserve a few reduce slots in the framework for speculative-tasks, failures
  2857. etc.</p>
  2858. <h4 id="ReducerNone">Reducer NONE</h4>
  2859. <p>It is legal to set the number of reduce-tasks to <code>zero</code>.</p>
  2860. <p>In this case the output of the map-tasks directly go to distributed
  2861. file-system, to the path set by
  2862. {@link FileOutputFormat#setOutputPath(JobConf, Path)}. Also, the
  2863. framework doesn't sort the map-outputs before writing it out to HDFS.</p>
  2864. @param n the number of reduce tasks for this job.]]>
  2865. </doc>
  2866. </method>
  2867. <method name="getMaxMapAttempts" return="int"
  2868. abstract="false" native="false" synchronized="false"
  2869. static="false" final="false" visibility="public"
  2870. deprecated="not deprecated">
  2871. <doc>
  2872. <![CDATA[Get the configured number of maximum attempts that will be made to run a
  2873. map task, as specified by the <code>mapred.map.max.attempts</code>
  2874. property. If this property is not already set, the default is 4 attempts.
  2875. @return the max number of attempts per map task.]]>
  2876. </doc>
  2877. </method>
  2878. <method name="setMaxMapAttempts"
  2879. abstract="false" native="false" synchronized="false"
  2880. static="false" final="false" visibility="public"
  2881. deprecated="not deprecated">
  2882. <param name="n" type="int"/>
  2883. <doc>
  2884. <![CDATA[Expert: Set the number of maximum attempts that will be made to run a
  2885. map task.
  2886. @param n the number of attempts per map task.]]>
  2887. </doc>
  2888. </method>
  2889. <method name="getMaxReduceAttempts" return="int"
  2890. abstract="false" native="false" synchronized="false"
  2891. static="false" final="false" visibility="public"
  2892. deprecated="not deprecated">
  2893. <doc>
  2894. <![CDATA[Get the configured number of maximum attempts that will be made to run a
  2895. reduce task, as specified by the <code>mapred.reduce.max.attempts</code>
  2896. property. If this property is not already set, the default is 4 attempts.
  2897. @return the max number of attempts per reduce task.]]>
  2898. </doc>
  2899. </method>
  2900. <method name="setMaxReduceAttempts"
  2901. abstract="false" native="false" synchronized="false"
  2902. static="false" final="false" visibility="public"
  2903. deprecated="not deprecated">
  2904. <param name="n" type="int"/>
  2905. <doc>
  2906. <![CDATA[Expert: Set the number of maximum attempts that will be made to run a
  2907. reduce task.
  2908. @param n the number of attempts per reduce task.]]>
  2909. </doc>
  2910. </method>
  2911. <method name="getJobName" return="java.lang.String"
  2912. abstract="false" native="false" synchronized="false"
  2913. static="false" final="false" visibility="public"
  2914. deprecated="not deprecated">
  2915. <doc>
  2916. <![CDATA[Get the user-specified job name. This is only used to identify the
  2917. job to the user.
  2918. @return the job's name, defaulting to "".]]>
  2919. </doc>
  2920. </method>
  2921. <method name="setJobName"
  2922. abstract="false" native="false" synchronized="false"
  2923. static="false" final="false" visibility="public"
  2924. deprecated="not deprecated">
  2925. <param name="name" type="java.lang.String"/>
  2926. <doc>
  2927. <![CDATA[Set the user-specified job name.
  2928. @param name the job's new name.]]>
  2929. </doc>
  2930. </method>
  2931. <method name="getSessionId" return="java.lang.String"
  2932. abstract="false" native="false" synchronized="false"
  2933. static="false" final="false" visibility="public"
  2934. deprecated="not deprecated">
  2935. <doc>
  2936. <![CDATA[Get the user-specified session identifier. The default is the empty string.
  2937. The session identifier is used to tag metric data that is reported to some
  2938. performance metrics system via the org.apache.hadoop.metrics API. The
  2939. session identifier is intended, in particular, for use by Hadoop-On-Demand
  2940. (HOD) which allocates a virtual Hadoop cluster dynamically and transiently.
  2941. HOD will set the session identifier by modifying the mapred-site.xml file
  2942. before starting the cluster.
  2943. When not running under HOD, this identifer is expected to remain set to
  2944. the empty string.
  2945. @return the session identifier, defaulting to "".]]>
  2946. </doc>
  2947. </method>
  2948. <method name="setSessionId"
  2949. abstract="false" native="false" synchronized="false"
  2950. static="false" final="false" visibility="public"
  2951. deprecated="not deprecated">
  2952. <param name="sessionId" type="java.lang.String"/>
  2953. <doc>
  2954. <![CDATA[Set the user-specified session identifier.
  2955. @param sessionId the new session id.]]>
  2956. </doc>
  2957. </method>
  2958. <method name="setMaxTaskFailuresPerTracker"
  2959. abstract="false" native="false" synchronized="false"
  2960. static="false" final="false" visibility="public"
  2961. deprecated="not deprecated">
  2962. <param name="noFailures" type="int"/>
  2963. <doc>
  2964. <![CDATA[Set the maximum no. of failures of a given job per tasktracker.
  2965. If the no. of task failures exceeds <code>noFailures</code>, the
  2966. tasktracker is <i>blacklisted</i> for this job.
  2967. @param noFailures maximum no. of failures of a given job per tasktracker.]]>
  2968. </doc>
  2969. </method>
  2970. <method name="getMaxTaskFailuresPerTracker" return="int"
  2971. abstract="false" native="false" synchronized="false"
  2972. static="false" final="false" visibility="public"
  2973. deprecated="not deprecated">
  2974. <doc>
  2975. <![CDATA[Expert: Get the maximum no. of failures of a given job per tasktracker.
  2976. If the no. of task failures exceeds this, the tasktracker is
  2977. <i>blacklisted</i> for this job.
  2978. @return the maximum no. of failures of a given job per tasktracker.]]>
  2979. </doc>
  2980. </method>
  2981. <method name="getMaxMapTaskFailuresPercent" return="int"
  2982. abstract="false" native="false" synchronized="false"
  2983. static="false" final="false" visibility="public"
  2984. deprecated="not deprecated">
  2985. <doc>
  2986. <![CDATA[Get the maximum percentage of map tasks that can fail without
  2987. the job being aborted.
  2988. Each map task is executed a minimum of {@link #getMaxMapAttempts()}
  2989. attempts before being declared as <i>failed</i>.
  2990. Defaults to <code>zero</code>, i.e. <i>any</i> failed map-task results in
  2991. the job being declared as {@link JobStatus#FAILED}.
  2992. @return the maximum percentage of map tasks that can fail without
  2993. the job being aborted.]]>
  2994. </doc>
  2995. </method>
  2996. <method name="setMaxMapTaskFailuresPercent"
  2997. abstract="false" native="false" synchronized="false"
  2998. static="false" final="false" visibility="public"
  2999. deprecated="not deprecated">
  3000. <param name="percent" type="int"/>
  3001. <doc>
  3002. <![CDATA[Expert: Set the maximum percentage of map tasks that can fail without the
  3003. job being aborted.
  3004. Each map task is executed a minimum of {@link #getMaxMapAttempts} attempts
  3005. before being declared as <i>failed</i>.
  3006. @param percent the maximum percentage of map tasks that can fail without
  3007. the job being aborted.]]>
  3008. </doc>
  3009. </method>
  3010. <method name="getMaxReduceTaskFailuresPercent" return="int"
  3011. abstract="false" native="false" synchronized="false"
  3012. static="false" final="false" visibility="public"
  3013. deprecated="not deprecated">
  3014. <doc>
  3015. <![CDATA[Get the maximum percentage of reduce tasks that can fail without
  3016. the job being aborted.
  3017. Each reduce task is executed a minimum of {@link #getMaxReduceAttempts()}
  3018. attempts before being declared as <i>failed</i>.
  3019. Defaults to <code>zero</code>, i.e. <i>any</i> failed reduce-task results
  3020. in the job being declared as {@link JobStatus#FAILED}.
  3021. @return the maximum percentage of reduce tasks that can fail without
  3022. the job being aborted.]]>
  3023. </doc>
  3024. </method>
  3025. <method name="setMaxReduceTaskFailuresPercent"
  3026. abstract="false" native="false" synchronized="false"
  3027. static="false" final="false" visibility="public"
  3028. deprecated="not deprecated">
  3029. <param name="percent" type="int"/>
  3030. <doc>
  3031. <![CDATA[Set the maximum percentage of reduce tasks that can fail without the job
  3032. being aborted.
  3033. Each reduce task is executed a minimum of {@link #getMaxReduceAttempts()}
  3034. attempts before being declared as <i>failed</i>.
  3035. @param percent the maximum percentage of reduce tasks that can fail without
  3036. the job being aborted.]]>
  3037. </doc>
  3038. </method>
  3039. <method name="setJobPriority"
  3040. abstract="false" native="false" synchronized="false"
  3041. static="false" final="false" visibility="public"
  3042. deprecated="not deprecated">
  3043. <param name="prio" type="org.apache.hadoop.mapred.JobPriority"/>
  3044. <doc>
  3045. <![CDATA[Set {@link JobPriority} for this job.
  3046. @param prio the {@link JobPriority} for this job.]]>
  3047. </doc>
  3048. </method>
  3049. <method name="getJobPriority" return="org.apache.hadoop.mapred.JobPriority"
  3050. abstract="false" native="false" synchronized="false"
  3051. static="false" final="false" visibility="public"
  3052. deprecated="not deprecated">
  3053. <doc>
  3054. <![CDATA[Get the {@link JobPriority} for this job.
  3055. @return the {@link JobPriority} for this job.]]>
  3056. </doc>
  3057. </method>
  3058. <method name="getProfileEnabled" return="boolean"
  3059. abstract="false" native="false" synchronized="false"
  3060. static="false" final="false" visibility="public"
  3061. deprecated="not deprecated">
  3062. <doc>
  3063. <![CDATA[Get whether the task profiling is enabled.
  3064. @return true if some tasks will be profiled]]>
  3065. </doc>
  3066. </method>
  3067. <method name="setProfileEnabled"
  3068. abstract="false" native="false" synchronized="false"
  3069. static="false" final="false" visibility="public"
  3070. deprecated="not deprecated">
  3071. <param name="newValue" type="boolean"/>
  3072. <doc>
  3073. <![CDATA[Set whether the system should collect profiler information for some of
  3074. the tasks in this job? The information is stored in the user log
  3075. directory.
  3076. @param newValue true means it should be gathered]]>
  3077. </doc>
  3078. </method>
  3079. <method name="getProfileParams" return="java.lang.String"
  3080. abstract="false" native="false" synchronized="false"
  3081. static="false" final="false" visibility="public"
  3082. deprecated="not deprecated">
  3083. <doc>
  3084. <![CDATA[Get the profiler configuration arguments.
  3085. The default value for this property is
  3086. "-agentlib:hprof=cpu=samples,heap=sites,force=n,thread=y,verbose=n,file=%s"
  3087. @return the parameters to pass to the task child to configure profiling]]>
  3088. </doc>
  3089. </method>
  3090. <method name="setProfileParams"
  3091. abstract="false" native="false" synchronized="false"
  3092. static="false" final="false" visibility="public"
  3093. deprecated="not deprecated">
  3094. <param name="value" type="java.lang.String"/>
  3095. <doc>
  3096. <![CDATA[Set the profiler configuration arguments. If the string contains a '%s' it
  3097. will be replaced with the name of the profiling output file when the task
  3098. runs.
  3099. This value is passed to the task child JVM on the command line.
  3100. @param value the configuration string]]>
  3101. </doc>
  3102. </method>
  3103. <method name="getProfileTaskRange" return="org.apache.hadoop.conf.Configuration.IntegerRanges"
  3104. abstract="false" native="false" synchronized="false"
  3105. static="false" final="false" visibility="public"
  3106. deprecated="not deprecated">
  3107. <param name="isMap" type="boolean"/>
  3108. <doc>
  3109. <![CDATA[Get the range of maps or reduces to profile.
  3110. @param isMap is the task a map?
  3111. @return the task ranges]]>
  3112. </doc>
  3113. </method>
  3114. <method name="setProfileTaskRange"
  3115. abstract="false" native="false" synchronized="false"
  3116. static="false" final="false" visibility="public"
  3117. deprecated="not deprecated">
  3118. <param name="isMap" type="boolean"/>
  3119. <param name="newValue" type="java.lang.String"/>
  3120. <doc>
  3121. <![CDATA[Set the ranges of maps or reduces to profile. setProfileEnabled(true)
  3122. must also be called.
  3123. @param newValue a set of integer ranges of the map ids]]>
  3124. </doc>
  3125. </method>
  3126. <method name="setMapDebugScript"
  3127. abstract="false" native="false" synchronized="false"
  3128. static="false" final="false" visibility="public"
  3129. deprecated="not deprecated">
  3130. <param name="mDbgScript" type="java.lang.String"/>
  3131. <doc>
  3132. <![CDATA[Set the debug script to run when the map tasks fail.
  3133. <p>The debug script can aid debugging of failed map tasks. The script is
  3134. given task's stdout, stderr, syslog, jobconf files as arguments.</p>
  3135. <p>The debug command, run on the node where the map failed, is:</p>
  3136. <p><pre><blockquote>
  3137. $script $stdout $stderr $syslog $jobconf.
  3138. </blockquote></pre></p>
  3139. <p> The script file is distributed through {@link DistributedCache}
  3140. APIs. The script needs to be symlinked. </p>
  3141. <p>Here is an example on how to submit a script
  3142. <p><blockquote><pre>
  3143. job.setMapDebugScript("./myscript");
  3144. DistributedCache.createSymlink(job);
  3145. DistributedCache.addCacheFile("/debug/scripts/myscript#myscript");
  3146. </pre></blockquote></p>
  3147. @param mDbgScript the script name]]>
  3148. </doc>
  3149. </method>
  3150. <method name="getMapDebugScript" return="java.lang.String"
  3151. abstract="false" native="false" synchronized="false"
  3152. static="false" final="false" visibility="public"
  3153. deprecated="not deprecated">
  3154. <doc>
  3155. <![CDATA[Get the map task's debug script.
  3156. @return the debug Script for the mapred job for failed map tasks.
  3157. @see #setMapDebugScript(String)]]>
  3158. </doc>
  3159. </method>
  3160. <method name="setReduceDebugScript"
  3161. abstract="false" native="false" synchronized="false"
  3162. static="false" final="false" visibility="public"
  3163. deprecated="not deprecated">
  3164. <param name="rDbgScript" type="java.lang.String"/>
  3165. <doc>
  3166. <![CDATA[Set the debug script to run when the reduce tasks fail.
  3167. <p>The debug script can aid debugging of failed reduce tasks. The script
  3168. is given task's stdout, stderr, syslog, jobconf files as arguments.</p>
  3169. <p>The debug command, run on the node where the map failed, is:</p>
  3170. <p><pre><blockquote>
  3171. $script $stdout $stderr $syslog $jobconf.
  3172. </blockquote></pre></p>
  3173. <p> The script file is distributed through {@link DistributedCache}
  3174. APIs. The script file needs to be symlinked </p>
  3175. <p>Here is an example on how to submit a script
  3176. <p><blockquote><pre>
  3177. job.setReduceDebugScript("./myscript");
  3178. DistributedCache.createSymlink(job);
  3179. DistributedCache.addCacheFile("/debug/scripts/myscript#myscript");
  3180. </pre></blockquote></p>
  3181. @param rDbgScript the script name]]>
  3182. </doc>
  3183. </method>
  3184. <method name="getReduceDebugScript" return="java.lang.String"
  3185. abstract="false" native="false" synchronized="false"
  3186. static="false" final="false" visibility="public"
  3187. deprecated="not deprecated">
  3188. <doc>
  3189. <![CDATA[Get the reduce task's debug Script
  3190. @return the debug script for the mapred job for failed reduce tasks.
  3191. @see #setReduceDebugScript(String)]]>
  3192. </doc>
  3193. </method>
  3194. <method name="getJobEndNotificationURI" return="java.lang.String"
  3195. abstract="false" native="false" synchronized="false"
  3196. static="false" final="false" visibility="public"
  3197. deprecated="not deprecated">
  3198. <doc>
  3199. <![CDATA[Get the uri to be invoked in-order to send a notification after the job
  3200. has completed (success/failure).
  3201. @return the job end notification uri, <code>null</code> if it hasn't
  3202. been set.
  3203. @see #setJobEndNotificationURI(String)]]>
  3204. </doc>
  3205. </method>
  3206. <method name="setJobEndNotificationURI"
  3207. abstract="false" native="false" synchronized="false"
  3208. static="false" final="false" visibility="public"
  3209. deprecated="not deprecated">
  3210. <param name="uri" type="java.lang.String"/>
  3211. <doc>
  3212. <![CDATA[Set the uri to be invoked in-order to send a notification after the job
  3213. has completed (success/failure).
  3214. <p>The uri can contain 2 special parameters: <tt>$jobId</tt> and
  3215. <tt>$jobStatus</tt>. Those, if present, are replaced by the job's
  3216. identifier and completion-status respectively.</p>
  3217. <p>This is typically used by application-writers to implement chaining of
  3218. Map-Reduce jobs in an <i>asynchronous manner</i>.</p>
  3219. @param uri the job end notification uri
  3220. @see JobStatus
  3221. @see <a href="{@docRoot}/org/apache/hadoop/mapred/JobClient.html#JobCompletionAndChaining">Job Completion and Chaining</a>]]>
  3222. </doc>
  3223. </method>
  3224. <method name="getJobLocalDir" return="java.lang.String"
  3225. abstract="false" native="false" synchronized="false"
  3226. static="false" final="false" visibility="public"
  3227. deprecated="not deprecated">
  3228. <doc>
  3229. <![CDATA[Get job-specific shared directory for use as scratch space
  3230. <p>
  3231. When a job starts, a shared directory is created at location
  3232. <code>
  3233. ${mapred.local.dir}/taskTracker/jobcache/$jobid/work/ </code>.
  3234. This directory is exposed to the users through
  3235. <code>job.local.dir </code>.
  3236. So, the tasks can use this space
  3237. as scratch space and share files among them. </p>
  3238. This value is available as System property also.
  3239. @return The localized job specific shared directory]]>
  3240. </doc>
  3241. </method>
  3242. <method name="getMaxVirtualMemoryForTask" return="long"
  3243. abstract="false" native="false" synchronized="false"
  3244. static="false" final="false" visibility="public"
  3245. deprecated="not deprecated">
  3246. <doc>
  3247. <![CDATA[The maximum amount of memory any task of this job will use. See
  3248. {@link #MAPRED_TASK_MAXVMEM_PROPERTY}
  3249. @return The maximum amount of memory any task of this job will use, in
  3250. bytes.
  3251. @see #setMaxVirtualMemoryForTask(long)]]>
  3252. </doc>
  3253. </method>
  3254. <method name="setMaxVirtualMemoryForTask"
  3255. abstract="false" native="false" synchronized="false"
  3256. static="false" final="false" visibility="public"
  3257. deprecated="not deprecated">
  3258. <param name="vmem" type="long"/>
  3259. <doc>
  3260. <![CDATA[Set the maximum amount of memory any task of this job can use. See
  3261. {@link #MAPRED_TASK_MAXVMEM_PROPERTY}
  3262. @param vmem Maximum amount of virtual memory in bytes any task of this job
  3263. can use.
  3264. @see #getMaxVirtualMemoryForTask()]]>
  3265. </doc>
  3266. </method>
  3267. <method name="getMaxPhysicalMemoryForTask" return="long"
  3268. abstract="false" native="false" synchronized="false"
  3269. static="false" final="false" visibility="public"
  3270. deprecated="not deprecated">
  3271. <doc>
  3272. <![CDATA[The maximum amount of physical memory any task of this job will use. See
  3273. {@link #MAPRED_TASK_MAXPMEM_PROPERTY}
  3274. @return The maximum amount of physical memory any task of this job will
  3275. use, in bytes.
  3276. @see #setMaxPhysicalMemoryForTask(long)]]>
  3277. </doc>
  3278. </method>
  3279. <method name="setMaxPhysicalMemoryForTask"
  3280. abstract="false" native="false" synchronized="false"
  3281. static="false" final="false" visibility="public"
  3282. deprecated="not deprecated">
  3283. <param name="pmem" type="long"/>
  3284. <doc>
  3285. <![CDATA[Set the maximum amount of physical memory any task of this job can use. See
  3286. {@link #MAPRED_TASK_MAXPMEM_PROPERTY}
  3287. @param pmem Maximum amount of physical memory in bytes any task of this job
  3288. can use.
  3289. @see #getMaxPhysicalMemoryForTask()]]>
  3290. </doc>
  3291. </method>
  3292. <method name="getQueueName" return="java.lang.String"
  3293. abstract="false" native="false" synchronized="false"
  3294. static="false" final="false" visibility="public"
  3295. deprecated="not deprecated">
  3296. <doc>
  3297. <![CDATA[Return the name of the queue to which this job is submitted.
  3298. Defaults to 'default'.
  3299. @return name of the queue]]>
  3300. </doc>
  3301. </method>
  3302. <method name="setQueueName"
  3303. abstract="false" native="false" synchronized="false"
  3304. static="false" final="false" visibility="public"
  3305. deprecated="not deprecated">
  3306. <param name="queueName" type="java.lang.String"/>
  3307. <doc>
  3308. <![CDATA[Set the name of the queue to which this job should be submitted.
  3309. @param queueName Name of the queue]]>
  3310. </doc>
  3311. </method>
  3312. <field name="DISABLED_MEMORY_LIMIT" type="long"
  3313. transient="false" volatile="false"
  3314. static="true" final="true" visibility="public"
  3315. deprecated="not deprecated">
  3316. <doc>
  3317. <![CDATA[A value which if set for memory related configuration options,
  3318. indicates that the options are turned off.]]>
  3319. </doc>
  3320. </field>
  3321. <field name="DEFAULT_QUEUE_NAME" type="java.lang.String"
  3322. transient="false" volatile="false"
  3323. static="true" final="true" visibility="public"
  3324. deprecated="not deprecated">
  3325. <doc>
  3326. <![CDATA[Name of the queue to which jobs will be submitted, if no queue
  3327. name is mentioned.]]>
  3328. </doc>
  3329. </field>
  3330. <field name="MAPRED_TASK_DEFAULT_MAXVMEM_PROPERTY" type="java.lang.String"
  3331. transient="false" volatile="false"
  3332. static="true" final="true" visibility="public"
  3333. deprecated="not deprecated">
  3334. <doc>
  3335. <![CDATA[Cluster-wide configuration to be set by the administrators that provides
  3336. default amount of maximum virtual memory for job's tasks. This has to be
  3337. set on both the JobTracker node for the sake of scheduling decisions and on
  3338. the TaskTracker nodes for the sake of memory management.
  3339. <p>
  3340. If a job doesn't specify its virtual memory requirement by setting
  3341. {@link #MAPRED_TASK_MAXVMEM_PROPERTY} to {@link #DISABLED_MEMORY_LIMIT},
  3342. tasks are assured a memory limit set to this property. This property is
  3343. disabled by default, and if not explicitly set to a valid value by the
  3344. administrators and if a job doesn't specify its virtual memory
  3345. requirements, the job's tasks will not be assured anything and may be
  3346. killed by a TT that intends to control the total memory usage of the tasks
  3347. via memory management functionality.
  3348. <p>
  3349. This value should in general be less than the cluster-wide configuration
  3350. {@link #UPPER_LIMIT_ON_TASK_VMEM_PROPERTY} . If not or if it not set,
  3351. TaskTracker's memory management may be disabled and a scheduler's memory
  3352. based scheduling decisions will be affected. Please refer to the
  3353. documentation of the configured scheduler to see how this property is used.]]>
  3354. </doc>
  3355. </field>
  3356. <field name="MAPRED_TASK_MAXVMEM_PROPERTY" type="java.lang.String"
  3357. transient="false" volatile="false"
  3358. static="true" final="true" visibility="public"
  3359. deprecated="not deprecated">
  3360. <doc>
  3361. <![CDATA[The maximum amount of memory any task of this job will use.
  3362. <p>
  3363. This value will be used by TaskTrackers for monitoring the memory usage of
  3364. tasks of this jobs. If a TaskTracker's memory management functionality is
  3365. enabled, each task of this job will be allowed to use a maximum virtual
  3366. memory specified by this property. If the task's memory usage goes over
  3367. this value, the task will be failed by the TT. If not set, the cluster-wide
  3368. configuration {@link #MAPRED_TASK_DEFAULT_MAXVMEM_PROPERTY} is used as the
  3369. default value for memory requirements. If this property cascaded with
  3370. {@link #MAPRED_TASK_DEFAULT_MAXVMEM_PROPERTY} becomes equal to -1, job's
  3371. tasks will not be assured anything and may be killed by a TT that intends
  3372. to control the total memory usage of the tasks via memory management
  3373. functionality. If the memory management functionality is disabled on a TT,
  3374. this value is ignored.
  3375. <p>
  3376. This value should also be not more than the cluster-wide configuration
  3377. {@link #UPPER_LIMIT_ON_TASK_VMEM_PROPERTY} which has to be set by the site
  3378. administrators.
  3379. <p>
  3380. This value may be used by schedulers that support scheduling based on job's
  3381. memory requirements. In general, a task of this job will be scheduled on a
  3382. TaskTracker only if the amount of virtual memory still unoccupied on the
  3383. TaskTracker is greater than or equal to this value. But different
  3384. schedulers can take different decisions. Please refer to the documentation
  3385. of the scheduler being configured to see if it does memory based scheduling
  3386. and if it does, how this property is used by that scheduler.
  3387. @see #setMaxVirtualMemoryForTask(long)
  3388. @see #getMaxVirtualMemoryForTask()]]>
  3389. </doc>
  3390. </field>
  3391. <field name="MAPRED_TASK_MAXPMEM_PROPERTY" type="java.lang.String"
  3392. transient="false" volatile="false"
  3393. static="true" final="true" visibility="public"
  3394. deprecated="not deprecated">
  3395. <doc>
  3396. <![CDATA[The maximum amount of physical memory any task of a job will use.
  3397. <p>
  3398. This value may be used by schedulers that support scheduling based on job's
  3399. memory requirements. In general, a task of this job will be scheduled on a
  3400. TaskTracker, only if the amount of physical memory still unoccupied on the
  3401. TaskTracker is greater than or equal to this value. But different
  3402. schedulers can take different decisions. Please refer to the documentation
  3403. of the scheduler being configured to see how it does memory based
  3404. scheduling and how this variable is used by that scheduler.
  3405. @see #setMaxPhysicalMemoryForTask(long)
  3406. @see #getMaxPhysicalMemoryForTask()]]>
  3407. </doc>
  3408. </field>
  3409. <field name="UPPER_LIMIT_ON_TASK_VMEM_PROPERTY" type="java.lang.String"
  3410. transient="false" volatile="false"
  3411. static="true" final="true" visibility="public"
  3412. deprecated="not deprecated">
  3413. <doc>
  3414. <![CDATA[Cluster-wide configuration to be set by the site administrators that
  3415. provides an upper limit on the maximum virtual memory that can be specified
  3416. by a job. The job configuration {@link #MAPRED_TASK_MAXVMEM_PROPERTY} and
  3417. the cluster-wide configuration
  3418. {@link #MAPRED_TASK_DEFAULT_MAXVMEM_PROPERTY} should, by definition, be
  3419. less than this value. If the job configuration
  3420. {@link #MAPRED_TASK_DEFAULT_MAXVMEM_PROPERTY} is more than this value,
  3421. depending on the scheduler being configured, the job may be rejected or the
  3422. job configuration may just be ignored.
  3423. <p>
  3424. If it is not set on a TaskTracker, TaskTracker's memory management will be
  3425. disabled.]]>
  3426. </doc>
  3427. </field>
  3428. <doc>
  3429. <![CDATA[A map/reduce job configuration.
  3430. <p><code>JobConf</code> is the primary interface for a user to describe a
  3431. map-reduce job to the Hadoop framework for execution. The framework tries to
  3432. faithfully execute the job as-is described by <code>JobConf</code>, however:
  3433. <ol>
  3434. <li>
  3435. Some configuration parameters might have been marked as
  3436. <a href="{@docRoot}/org/apache/hadoop/conf/Configuration.html#FinalParams">
  3437. final</a> by administrators and hence cannot be altered.
  3438. </li>
  3439. <li>
  3440. While some job parameters are straight-forward to set
  3441. (e.g. {@link #setNumReduceTasks(int)}), some parameters interact subtly
  3442. rest of the framework and/or job-configuration and is relatively more
  3443. complex for the user to control finely (e.g. {@link #setNumMapTasks(int)}).
  3444. </li>
  3445. </ol></p>
  3446. <p><code>JobConf</code> typically specifies the {@link Mapper}, combiner
  3447. (if any), {@link Partitioner}, {@link Reducer}, {@link InputFormat} and
  3448. {@link OutputFormat} implementations to be used etc.
  3449. <p>Optionally <code>JobConf</code> is used to specify other advanced facets
  3450. of the job such as <code>Comparator</code>s to be used, files to be put in
  3451. the {@link DistributedCache}, whether or not intermediate and/or job outputs
  3452. are to be compressed (and how), debugability via user-provided scripts
  3453. ( {@link #setMapDebugScript(String)}/{@link #setReduceDebugScript(String)}),
  3454. for doing post-processing on task logs, task's stdout, stderr, syslog.
  3455. and etc.</p>
  3456. <p>Here is an example on how to configure a job via <code>JobConf</code>:</p>
  3457. <p><blockquote><pre>
  3458. // Create a new JobConf
  3459. JobConf job = new JobConf(new Configuration(), MyJob.class);
  3460. // Specify various job-specific parameters
  3461. job.setJobName("myjob");
  3462. FileInputFormat.setInputPaths(job, new Path("in"));
  3463. FileOutputFormat.setOutputPath(job, new Path("out"));
  3464. job.setMapperClass(MyJob.MyMapper.class);
  3465. job.setCombinerClass(MyJob.MyReducer.class);
  3466. job.setReducerClass(MyJob.MyReducer.class);
  3467. job.setInputFormat(SequenceFileInputFormat.class);
  3468. job.setOutputFormat(SequenceFileOutputFormat.class);
  3469. </pre></blockquote></p>
  3470. @see JobClient
  3471. @see ClusterStatus
  3472. @see Tool
  3473. @see DistributedCache
  3474. @deprecated Use {@link Configuration} instead]]>
  3475. </doc>
  3476. </class>
  3477. <!-- end class org.apache.hadoop.mapred.JobConf -->
  3478. <!-- start interface org.apache.hadoop.mapred.JobConfigurable -->
  3479. <interface name="JobConfigurable" abstract="true"
  3480. static="false" final="false" visibility="public"
  3481. deprecated="not deprecated">
  3482. <method name="configure"
  3483. abstract="false" native="false" synchronized="false"
  3484. static="false" final="false" visibility="public"
  3485. deprecated="not deprecated">
  3486. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  3487. <doc>
  3488. <![CDATA[Initializes a new instance from a {@link JobConf}.
  3489. @param job the configuration]]>
  3490. </doc>
  3491. </method>
  3492. <doc>
  3493. <![CDATA[That what may be configured.]]>
  3494. </doc>
  3495. </interface>
  3496. <!-- end interface org.apache.hadoop.mapred.JobConfigurable -->
  3497. <!-- start class org.apache.hadoop.mapred.JobContext -->
  3498. <class name="JobContext" extends="org.apache.hadoop.mapreduce.JobContext"
  3499. abstract="false"
  3500. static="false" final="false" visibility="public"
  3501. deprecated="Use {@link org.apache.hadoop.mapreduce.JobContext} instead.">
  3502. <method name="getJobConf" return="org.apache.hadoop.mapred.JobConf"
  3503. abstract="false" native="false" synchronized="false"
  3504. static="false" final="false" visibility="public"
  3505. deprecated="not deprecated">
  3506. <doc>
  3507. <![CDATA[Get the job Configuration
  3508. @return JobConf]]>
  3509. </doc>
  3510. </method>
  3511. <method name="getProgressible" return="org.apache.hadoop.util.Progressable"
  3512. abstract="false" native="false" synchronized="false"
  3513. static="false" final="false" visibility="public"
  3514. deprecated="not deprecated">
  3515. <doc>
  3516. <![CDATA[Get the progress mechanism for reporting progress.
  3517. @return progress mechanism]]>
  3518. </doc>
  3519. </method>
  3520. <doc>
  3521. <![CDATA[@deprecated Use {@link org.apache.hadoop.mapreduce.JobContext} instead.]]>
  3522. </doc>
  3523. </class>
  3524. <!-- end class org.apache.hadoop.mapred.JobContext -->
  3525. <!-- start class org.apache.hadoop.mapred.JobEndNotifier -->
  3526. <class name="JobEndNotifier" extends="java.lang.Object"
  3527. abstract="false"
  3528. static="false" final="false" visibility="public"
  3529. deprecated="not deprecated">
  3530. <constructor name="JobEndNotifier"
  3531. static="false" final="false" visibility="public"
  3532. deprecated="not deprecated">
  3533. </constructor>
  3534. <method name="startNotifier"
  3535. abstract="false" native="false" synchronized="false"
  3536. static="true" final="false" visibility="public"
  3537. deprecated="not deprecated">
  3538. </method>
  3539. <method name="stopNotifier"
  3540. abstract="false" native="false" synchronized="false"
  3541. static="true" final="false" visibility="public"
  3542. deprecated="not deprecated">
  3543. </method>
  3544. <method name="registerNotification"
  3545. abstract="false" native="false" synchronized="false"
  3546. static="true" final="false" visibility="public"
  3547. deprecated="not deprecated">
  3548. <param name="jobConf" type="org.apache.hadoop.mapred.JobConf"/>
  3549. <param name="status" type="org.apache.hadoop.mapred.JobStatus"/>
  3550. </method>
  3551. <method name="localRunnerNotification"
  3552. abstract="false" native="false" synchronized="false"
  3553. static="true" final="false" visibility="public"
  3554. deprecated="not deprecated">
  3555. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  3556. <param name="status" type="org.apache.hadoop.mapred.JobStatus"/>
  3557. </method>
  3558. </class>
  3559. <!-- end class org.apache.hadoop.mapred.JobEndNotifier -->
  3560. <!-- start class org.apache.hadoop.mapred.JobHistory -->
  3561. <class name="JobHistory" extends="java.lang.Object"
  3562. abstract="false"
  3563. static="false" final="false" visibility="public"
  3564. deprecated="not deprecated">
  3565. <constructor name="JobHistory"
  3566. static="false" final="false" visibility="public"
  3567. deprecated="not deprecated">
  3568. </constructor>
  3569. <method name="init" return="boolean"
  3570. abstract="false" native="false" synchronized="false"
  3571. static="true" final="false" visibility="public"
  3572. deprecated="not deprecated">
  3573. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  3574. <param name="hostname" type="java.lang.String"/>
  3575. <param name="jobTrackerStartTime" type="long"/>
  3576. <doc>
  3577. <![CDATA[Initialize JobHistory files.
  3578. @param conf Jobconf of the job tracker.
  3579. @param hostname jobtracker's hostname
  3580. @param jobTrackerStartTime jobtracker's start time
  3581. @return true if intialized properly
  3582. false otherwise]]>
  3583. </doc>
  3584. </method>
  3585. <method name="parseHistoryFromFS"
  3586. abstract="false" native="false" synchronized="false"
  3587. static="true" final="false" visibility="public"
  3588. deprecated="not deprecated">
  3589. <param name="path" type="java.lang.String"/>
  3590. <param name="l" type="org.apache.hadoop.mapred.JobHistory.Listener"/>
  3591. <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
  3592. <exception name="IOException" type="java.io.IOException"/>
  3593. <doc>
  3594. <![CDATA[Parses history file and invokes Listener.handle() for
  3595. each line of history. It can be used for looking through history
  3596. files for specific items without having to keep whole history in memory.
  3597. @param path path to history file
  3598. @param l Listener for history events
  3599. @param fs FileSystem where history file is present
  3600. @throws IOException]]>
  3601. </doc>
  3602. </method>
  3603. <method name="isDisableHistory" return="boolean"
  3604. abstract="false" native="false" synchronized="false"
  3605. static="true" final="false" visibility="public"
  3606. deprecated="not deprecated">
  3607. <doc>
  3608. <![CDATA[Returns history disable status. by default history is enabled so this
  3609. method returns false.
  3610. @return true if history logging is disabled, false otherwise.]]>
  3611. </doc>
  3612. </method>
  3613. <method name="setDisableHistory"
  3614. abstract="false" native="false" synchronized="false"
  3615. static="true" final="false" visibility="public"
  3616. deprecated="not deprecated">
  3617. <param name="disableHistory" type="boolean"/>
  3618. <doc>
  3619. <![CDATA[Enable/disable history logging. Default value is false, so history
  3620. is enabled by default.
  3621. @param disableHistory true if history should be disabled, false otherwise.]]>
  3622. </doc>
  3623. </method>
  3624. <method name="getTaskLogsUrl" return="java.lang.String"
  3625. abstract="false" native="false" synchronized="false"
  3626. static="true" final="false" visibility="public"
  3627. deprecated="not deprecated">
  3628. <param name="attempt" type="org.apache.hadoop.mapred.JobHistory.TaskAttempt"/>
  3629. <doc>
  3630. <![CDATA[Return the TaskLogsUrl of a particular TaskAttempt
  3631. @param attempt
  3632. @return the taskLogsUrl. null if http-port or tracker-name or
  3633. task-attempt-id are unavailable.]]>
  3634. </doc>
  3635. </method>
  3636. <field name="LOG" type="org.apache.commons.logging.Log"
  3637. transient="false" volatile="false"
  3638. static="true" final="true" visibility="public"
  3639. deprecated="not deprecated">
  3640. </field>
  3641. <field name="JOB_NAME_TRIM_LENGTH" type="int"
  3642. transient="false" volatile="false"
  3643. static="true" final="true" visibility="public"
  3644. deprecated="not deprecated">
  3645. </field>
  3646. <doc>
  3647. <![CDATA[Provides methods for writing to and reading from job history.
  3648. Job History works in an append mode, JobHistory and its inner classes provide methods
  3649. to log job events.
  3650. JobHistory is split into multiple files, format of each file is plain text where each line
  3651. is of the format [type (key=value)*], where type identifies the type of the record.
  3652. Type maps to UID of one of the inner classes of this class.
  3653. Job history is maintained in a master index which contains star/stop times of all jobs with
  3654. a few other job level properties. Apart from this each job's history is maintained in a seperate history
  3655. file. name of job history files follows the format jobtrackerId_jobid
  3656. For parsing the job history it supports a listener based interface where each line is parsed
  3657. and passed to listener. The listener can create an object model of history or look for specific
  3658. events and discard rest of the history.
  3659. CHANGE LOG :
  3660. Version 0 : The history has the following format :
  3661. TAG KEY1="VALUE1" KEY2="VALUE2" and so on.
  3662. TAG can be Job, Task, MapAttempt or ReduceAttempt.
  3663. Note that a '"' is the line delimiter.
  3664. Version 1 : Changes the line delimiter to '.'
  3665. Values are now escaped for unambiguous parsing.
  3666. Added the Meta tag to store version info.]]>
  3667. </doc>
  3668. </class>
  3669. <!-- end class org.apache.hadoop.mapred.JobHistory -->
  3670. <!-- start class org.apache.hadoop.mapred.JobHistory.HistoryCleaner -->
  3671. <class name="JobHistory.HistoryCleaner" extends="java.lang.Object"
  3672. abstract="false"
  3673. static="true" final="false" visibility="public"
  3674. deprecated="not deprecated">
  3675. <implements name="java.lang.Runnable"/>
  3676. <constructor name="JobHistory.HistoryCleaner"
  3677. static="false" final="false" visibility="public"
  3678. deprecated="not deprecated">
  3679. </constructor>
  3680. <method name="run"
  3681. abstract="false" native="false" synchronized="false"
  3682. static="false" final="false" visibility="public"
  3683. deprecated="not deprecated">
  3684. <doc>
  3685. <![CDATA[Cleans up history data.]]>
  3686. </doc>
  3687. </method>
  3688. <doc>
  3689. <![CDATA[Delete history files older than one month. Update master index and remove all
  3690. jobs older than one month. Also if a job tracker has no jobs in last one month
  3691. remove reference to the job tracker.]]>
  3692. </doc>
  3693. </class>
  3694. <!-- end class org.apache.hadoop.mapred.JobHistory.HistoryCleaner -->
  3695. <!-- start class org.apache.hadoop.mapred.JobHistory.JobInfo -->
  3696. <class name="JobHistory.JobInfo" extends="org.apache.hadoop.mapred.JobHistory.KeyValuePair"
  3697. abstract="false"
  3698. static="true" final="false" visibility="public"
  3699. deprecated="not deprecated">
  3700. <constructor name="JobHistory.JobInfo" type="java.lang.String"
  3701. static="false" final="false" visibility="public"
  3702. deprecated="not deprecated">
  3703. <doc>
  3704. <![CDATA[Create new JobInfo]]>
  3705. </doc>
  3706. </constructor>
  3707. <method name="getAllTasks" return="java.util.Map"
  3708. abstract="false" native="false" synchronized="false"
  3709. static="false" final="false" visibility="public"
  3710. deprecated="not deprecated">
  3711. <doc>
  3712. <![CDATA[Returns all map and reduce tasks <taskid-Task>.]]>
  3713. </doc>
  3714. </method>
  3715. <method name="getLocalJobFilePath" return="java.lang.String"
  3716. abstract="false" native="false" synchronized="false"
  3717. static="true" final="false" visibility="public"
  3718. deprecated="not deprecated">
  3719. <param name="jobId" type="org.apache.hadoop.mapred.JobID"/>
  3720. <doc>
  3721. <![CDATA[Get the path of the locally stored job file
  3722. @param jobId id of the job
  3723. @return the path of the job file on the local file system]]>
  3724. </doc>
  3725. </method>
  3726. <method name="encodeJobHistoryFilePath" return="java.lang.String"
  3727. abstract="false" native="false" synchronized="false"
  3728. static="true" final="false" visibility="public"
  3729. deprecated="not deprecated">
  3730. <param name="logFile" type="java.lang.String"/>
  3731. <exception name="IOException" type="java.io.IOException"/>
  3732. <doc>
  3733. <![CDATA[Helper function to encode the URL of the path of the job-history
  3734. log file.
  3735. @param logFile path of the job-history file
  3736. @return URL encoded path
  3737. @throws IOException]]>
  3738. </doc>
  3739. </method>
  3740. <method name="encodeJobHistoryFileName" return="java.lang.String"
  3741. abstract="false" native="false" synchronized="false"
  3742. static="true" final="false" visibility="public"
  3743. deprecated="not deprecated">
  3744. <param name="logFileName" type="java.lang.String"/>
  3745. <exception name="IOException" type="java.io.IOException"/>
  3746. <doc>
  3747. <![CDATA[Helper function to encode the URL of the filename of the job-history
  3748. log file.
  3749. @param logFileName file name of the job-history file
  3750. @return URL encoded filename
  3751. @throws IOException]]>
  3752. </doc>
  3753. </method>
  3754. <method name="decodeJobHistoryFileName" return="java.lang.String"
  3755. abstract="false" native="false" synchronized="false"
  3756. static="true" final="false" visibility="public"
  3757. deprecated="not deprecated">
  3758. <param name="logFileName" type="java.lang.String"/>
  3759. <exception name="IOException" type="java.io.IOException"/>
  3760. <doc>
  3761. <![CDATA[Helper function to decode the URL of the filename of the job-history
  3762. log file.
  3763. @param logFileName file name of the job-history file
  3764. @return URL decoded filename
  3765. @throws IOException]]>
  3766. </doc>
  3767. </method>
  3768. <method name="getUserName" return="java.lang.String"
  3769. abstract="false" native="false" synchronized="false"
  3770. static="true" final="false" visibility="public"
  3771. deprecated="not deprecated">
  3772. <param name="jobConf" type="org.apache.hadoop.mapred.JobConf"/>
  3773. <doc>
  3774. <![CDATA[Get the user name from the job conf]]>
  3775. </doc>
  3776. </method>
  3777. <method name="getJobHistoryLogLocation" return="org.apache.hadoop.fs.Path"
  3778. abstract="false" native="false" synchronized="false"
  3779. static="true" final="false" visibility="public"
  3780. deprecated="not deprecated">
  3781. <param name="logFileName" type="java.lang.String"/>
  3782. <doc>
  3783. <![CDATA[Get the job history file path given the history filename]]>
  3784. </doc>
  3785. </method>
  3786. <method name="getJobHistoryLogLocationForUser" return="org.apache.hadoop.fs.Path"
  3787. abstract="false" native="false" synchronized="false"
  3788. static="true" final="false" visibility="public"
  3789. deprecated="not deprecated">
  3790. <param name="logFileName" type="java.lang.String"/>
  3791. <param name="jobConf" type="org.apache.hadoop.mapred.JobConf"/>
  3792. <doc>
  3793. <![CDATA[Get the user job history file path]]>
  3794. </doc>
  3795. </method>
  3796. <method name="getJobHistoryFileName" return="java.lang.String"
  3797. abstract="false" native="false" synchronized="true"
  3798. static="true" final="false" visibility="public"
  3799. deprecated="not deprecated">
  3800. <param name="jobConf" type="org.apache.hadoop.mapred.JobConf"/>
  3801. <param name="id" type="org.apache.hadoop.mapred.JobID"/>
  3802. <exception name="IOException" type="java.io.IOException"/>
  3803. <doc>
  3804. <![CDATA[Recover the job history filename from the history folder.
  3805. Uses the following pattern
  3806. $jt-hostname_[0-9]*_$job-id_$user-$job-name*
  3807. @param jobConf the job conf
  3808. @param id job id]]>
  3809. </doc>
  3810. </method>
  3811. <method name="recoverJobHistoryFile" return="org.apache.hadoop.fs.Path"
  3812. abstract="false" native="false" synchronized="true"
  3813. static="true" final="false" visibility="public"
  3814. deprecated="not deprecated">
  3815. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  3816. <param name="logFilePath" type="org.apache.hadoop.fs.Path"/>
  3817. <exception name="IOException" type="java.io.IOException"/>
  3818. <doc>
  3819. <![CDATA[Selects one of the two files generated as a part of recovery.
  3820. The thumb rule is that always select the oldest file.
  3821. This call makes sure that only one file is left in the end.
  3822. @param conf job conf
  3823. @param logFilePath Path of the log file
  3824. @throws IOException]]>
  3825. </doc>
  3826. </method>
  3827. <method name="logSubmitted"
  3828. abstract="false" native="false" synchronized="false"
  3829. static="true" final="false" visibility="public"
  3830. deprecated="not deprecated">
  3831. <param name="jobId" type="org.apache.hadoop.mapred.JobID"/>
  3832. <param name="jobConf" type="org.apache.hadoop.mapred.JobConf"/>
  3833. <param name="jobConfPath" type="java.lang.String"/>
  3834. <param name="submitTime" type="long"/>
  3835. <exception name="IOException" type="java.io.IOException"/>
  3836. <doc>
  3837. <![CDATA[Log job submitted event to history. Creates a new file in history
  3838. for the job. if history file creation fails, it disables history
  3839. for all other events.
  3840. @param jobId job id assigned by job tracker.
  3841. @param jobConf job conf of the job
  3842. @param jobConfPath path to job conf xml file in HDFS.
  3843. @param submitTime time when job tracker received the job
  3844. @throws IOException]]>
  3845. </doc>
  3846. </method>
  3847. <method name="logInited"
  3848. abstract="false" native="false" synchronized="false"
  3849. static="true" final="false" visibility="public"
  3850. deprecated="not deprecated">
  3851. <param name="jobId" type="org.apache.hadoop.mapred.JobID"/>
  3852. <param name="startTime" type="long"/>
  3853. <param name="totalMaps" type="int"/>
  3854. <param name="totalReduces" type="int"/>
  3855. <doc>
  3856. <![CDATA[Logs launch time of job.
  3857. @param jobId job id, assigned by jobtracker.
  3858. @param startTime start time of job.
  3859. @param totalMaps total maps assigned by jobtracker.
  3860. @param totalReduces total reduces.]]>
  3861. </doc>
  3862. </method>
  3863. <method name="logStarted"
  3864. abstract="false" native="false" synchronized="false"
  3865. static="true" final="false" visibility="public"
  3866. deprecated="Use {@link #logInited(JobID, long, int, int)} and
  3867. {@link #logStarted(JobID)}">
  3868. <param name="jobId" type="org.apache.hadoop.mapred.JobID"/>
  3869. <param name="startTime" type="long"/>
  3870. <param name="totalMaps" type="int"/>
  3871. <param name="totalReduces" type="int"/>
  3872. <doc>
  3873. <![CDATA[Logs the job as RUNNING.
  3874. @param jobId job id, assigned by jobtracker.
  3875. @param startTime start time of job.
  3876. @param totalMaps total maps assigned by jobtracker.
  3877. @param totalReduces total reduces.
  3878. @deprecated Use {@link #logInited(JobID, long, int, int)} and
  3879. {@link #logStarted(JobID)}]]>
  3880. </doc>
  3881. </method>
  3882. <method name="logStarted"
  3883. abstract="false" native="false" synchronized="false"
  3884. static="true" final="false" visibility="public"
  3885. deprecated="not deprecated">
  3886. <param name="jobId" type="org.apache.hadoop.mapred.JobID"/>
  3887. <doc>
  3888. <![CDATA[Logs job as running
  3889. @param jobId job id, assigned by jobtracker.]]>
  3890. </doc>
  3891. </method>
  3892. <method name="logFinished"
  3893. abstract="false" native="false" synchronized="false"
  3894. static="true" final="false" visibility="public"
  3895. deprecated="not deprecated">
  3896. <param name="jobId" type="org.apache.hadoop.mapred.JobID"/>
  3897. <param name="finishTime" type="long"/>
  3898. <param name="finishedMaps" type="int"/>
  3899. <param name="finishedReduces" type="int"/>
  3900. <param name="failedMaps" type="int"/>
  3901. <param name="failedReduces" type="int"/>
  3902. <param name="counters" type="org.apache.hadoop.mapred.Counters"/>
  3903. <doc>
  3904. <![CDATA[Log job finished. closes the job file in history.
  3905. @param jobId job id, assigned by jobtracker.
  3906. @param finishTime finish time of job in ms.
  3907. @param finishedMaps no of maps successfully finished.
  3908. @param finishedReduces no of reduces finished sucessfully.
  3909. @param failedMaps no of failed map tasks.
  3910. @param failedReduces no of failed reduce tasks.
  3911. @param counters the counters from the job]]>
  3912. </doc>
  3913. </method>
  3914. <method name="logFailed"
  3915. abstract="false" native="false" synchronized="false"
  3916. static="true" final="false" visibility="public"
  3917. deprecated="not deprecated">
  3918. <param name="jobid" type="org.apache.hadoop.mapred.JobID"/>
  3919. <param name="timestamp" type="long"/>
  3920. <param name="finishedMaps" type="int"/>
  3921. <param name="finishedReduces" type="int"/>
  3922. <doc>
  3923. <![CDATA[Logs job failed event. Closes the job history log file.
  3924. @param jobid job id
  3925. @param timestamp time when job failure was detected in ms.
  3926. @param finishedMaps no finished map tasks.
  3927. @param finishedReduces no of finished reduce tasks.]]>
  3928. </doc>
  3929. </method>
  3930. <method name="logKilled"
  3931. abstract="false" native="false" synchronized="false"
  3932. static="true" final="false" visibility="public"
  3933. deprecated="not deprecated">
  3934. <param name="jobid" type="org.apache.hadoop.mapred.JobID"/>
  3935. <param name="timestamp" type="long"/>
  3936. <param name="finishedMaps" type="int"/>
  3937. <param name="finishedReduces" type="int"/>
  3938. <doc>
  3939. <![CDATA[Logs job killed event. Closes the job history log file.
  3940. @param jobid
  3941. job id
  3942. @param timestamp
  3943. time when job killed was issued in ms.
  3944. @param finishedMaps
  3945. no finished map tasks.
  3946. @param finishedReduces
  3947. no of finished reduce tasks.]]>
  3948. </doc>
  3949. </method>
  3950. <method name="logJobPriority"
  3951. abstract="false" native="false" synchronized="false"
  3952. static="true" final="false" visibility="public"
  3953. deprecated="not deprecated">
  3954. <param name="jobid" type="org.apache.hadoop.mapred.JobID"/>
  3955. <param name="priority" type="org.apache.hadoop.mapred.JobPriority"/>
  3956. <doc>
  3957. <![CDATA[Log job's priority.
  3958. @param jobid job id
  3959. @param priority Jobs priority]]>
  3960. </doc>
  3961. </method>
  3962. <method name="logJobInfo"
  3963. abstract="false" native="false" synchronized="false"
  3964. static="true" final="false" visibility="public"
  3965. deprecated="Use {@link #logJobInfo(JobID, long, long)} instead.">
  3966. <param name="jobid" type="org.apache.hadoop.mapred.JobID"/>
  3967. <param name="submitTime" type="long"/>
  3968. <param name="launchTime" type="long"/>
  3969. <param name="restartCount" type="int"/>
  3970. <doc>
  3971. <![CDATA[Log job's submit-time/launch-time
  3972. @param jobid job id
  3973. @param submitTime job's submit time
  3974. @param launchTime job's launch time
  3975. @param restartCount number of times the job got restarted
  3976. @deprecated Use {@link #logJobInfo(JobID, long, long)} instead.]]>
  3977. </doc>
  3978. </method>
  3979. <method name="logJobInfo"
  3980. abstract="false" native="false" synchronized="false"
  3981. static="true" final="false" visibility="public"
  3982. deprecated="not deprecated">
  3983. <param name="jobid" type="org.apache.hadoop.mapred.JobID"/>
  3984. <param name="submitTime" type="long"/>
  3985. <param name="launchTime" type="long"/>
  3986. </method>
  3987. <doc>
  3988. <![CDATA[Helper class for logging or reading back events related to job start, finish or failure.]]>
  3989. </doc>
  3990. </class>
  3991. <!-- end class org.apache.hadoop.mapred.JobHistory.JobInfo -->
  3992. <!-- start class org.apache.hadoop.mapred.JobHistory.Keys -->
  3993. <class name="JobHistory.Keys" extends="java.lang.Enum"
  3994. abstract="false"
  3995. static="true" final="true" visibility="public"
  3996. deprecated="not deprecated">
  3997. <method name="values" return="org.apache.hadoop.mapred.JobHistory.Keys[]"
  3998. abstract="false" native="false" synchronized="false"
  3999. static="true" final="false" visibility="public"
  4000. deprecated="not deprecated">
  4001. </method>
  4002. <method name="valueOf" return="org.apache.hadoop.mapred.JobHistory.Keys"
  4003. abstract="false" native="false" synchronized="false"
  4004. static="true" final="false" visibility="public"
  4005. deprecated="not deprecated">
  4006. <param name="name" type="java.lang.String"/>
  4007. </method>
  4008. <field name="JOBTRACKERID" type="org.apache.hadoop.mapred.JobHistory.Keys"
  4009. transient="false" volatile="false"
  4010. static="true" final="true" visibility="public"
  4011. deprecated="not deprecated">
  4012. </field>
  4013. <field name="START_TIME" type="org.apache.hadoop.mapred.JobHistory.Keys"
  4014. transient="false" volatile="false"
  4015. static="true" final="true" visibility="public"
  4016. deprecated="not deprecated">
  4017. </field>
  4018. <field name="FINISH_TIME" type="org.apache.hadoop.mapred.JobHistory.Keys"
  4019. transient="false" volatile="false"
  4020. static="true" final="true" visibility="public"
  4021. deprecated="not deprecated">
  4022. </field>
  4023. <field name="JOBID" type="org.apache.hadoop.mapred.JobHistory.Keys"
  4024. transient="false" volatile="false"
  4025. static="true" final="true" visibility="public"
  4026. deprecated="not deprecated">
  4027. </field>
  4028. <field name="JOBNAME" type="org.apache.hadoop.mapred.JobHistory.Keys"
  4029. transient="false" volatile="false"
  4030. static="true" final="true" visibility="public"
  4031. deprecated="not deprecated">
  4032. </field>
  4033. <field name="USER" type="org.apache.hadoop.mapred.JobHistory.Keys"
  4034. transient="false" volatile="false"
  4035. static="true" final="true" visibility="public"
  4036. deprecated="not deprecated">
  4037. </field>
  4038. <field name="JOBCONF" type="org.apache.hadoop.mapred.JobHistory.Keys"
  4039. transient="false" volatile="false"
  4040. static="true" final="true" visibility="public"
  4041. deprecated="not deprecated">
  4042. </field>
  4043. <field name="SUBMIT_TIME" type="org.apache.hadoop.mapred.JobHistory.Keys"
  4044. transient="false" volatile="false"
  4045. static="true" final="true" visibility="public"
  4046. deprecated="not deprecated">
  4047. </field>
  4048. <field name="LAUNCH_TIME" type="org.apache.hadoop.mapred.JobHistory.Keys"
  4049. transient="false" volatile="false"
  4050. static="true" final="true" visibility="public"
  4051. deprecated="not deprecated">
  4052. </field>
  4053. <field name="TOTAL_MAPS" type="org.apache.hadoop.mapred.JobHistory.Keys"
  4054. transient="false" volatile="false"
  4055. static="true" final="true" visibility="public"
  4056. deprecated="not deprecated">
  4057. </field>
  4058. <field name="TOTAL_REDUCES" type="org.apache.hadoop.mapred.JobHistory.Keys"
  4059. transient="false" volatile="false"
  4060. static="true" final="true" visibility="public"
  4061. deprecated="not deprecated">
  4062. </field>
  4063. <field name="FAILED_MAPS" type="org.apache.hadoop.mapred.JobHistory.Keys"
  4064. transient="false" volatile="false"
  4065. static="true" final="true" visibility="public"
  4066. deprecated="not deprecated">
  4067. </field>
  4068. <field name="FAILED_REDUCES" type="org.apache.hadoop.mapred.JobHistory.Keys"
  4069. transient="false" volatile="false"
  4070. static="true" final="true" visibility="public"
  4071. deprecated="not deprecated">
  4072. </field>
  4073. <field name="FINISHED_MAPS" type="org.apache.hadoop.mapred.JobHistory.Keys"
  4074. transient="false" volatile="false"
  4075. static="true" final="true" visibility="public"
  4076. deprecated="not deprecated">
  4077. </field>
  4078. <field name="FINISHED_REDUCES" type="org.apache.hadoop.mapred.JobHistory.Keys"
  4079. transient="false" volatile="false"
  4080. static="true" final="true" visibility="public"
  4081. deprecated="not deprecated">
  4082. </field>
  4083. <field name="JOB_STATUS" type="org.apache.hadoop.mapred.JobHistory.Keys"
  4084. transient="false" volatile="false"
  4085. static="true" final="true" visibility="public"
  4086. deprecated="not deprecated">
  4087. </field>
  4088. <field name="TASKID" type="org.apache.hadoop.mapred.JobHistory.Keys"
  4089. transient="false" volatile="false"
  4090. static="true" final="true" visibility="public"
  4091. deprecated="not deprecated">
  4092. </field>
  4093. <field name="HOSTNAME" type="org.apache.hadoop.mapred.JobHistory.Keys"
  4094. transient="false" volatile="false"
  4095. static="true" final="true" visibility="public"
  4096. deprecated="not deprecated">
  4097. </field>
  4098. <field name="TASK_TYPE" type="org.apache.hadoop.mapred.JobHistory.Keys"
  4099. transient="false" volatile="false"
  4100. static="true" final="true" visibility="public"
  4101. deprecated="not deprecated">
  4102. </field>
  4103. <field name="ERROR" type="org.apache.hadoop.mapred.JobHistory.Keys"
  4104. transient="false" volatile="false"
  4105. static="true" final="true" visibility="public"
  4106. deprecated="not deprecated">
  4107. </field>
  4108. <field name="TASK_ATTEMPT_ID" type="org.apache.hadoop.mapred.JobHistory.Keys"
  4109. transient="false" volatile="false"
  4110. static="true" final="true" visibility="public"
  4111. deprecated="not deprecated">
  4112. </field>
  4113. <field name="TASK_STATUS" type="org.apache.hadoop.mapred.JobHistory.Keys"
  4114. transient="false" volatile="false"
  4115. static="true" final="true" visibility="public"
  4116. deprecated="not deprecated">
  4117. </field>
  4118. <field name="COPY_PHASE" type="org.apache.hadoop.mapred.JobHistory.Keys"
  4119. transient="false" volatile="false"
  4120. static="true" final="true" visibility="public"
  4121. deprecated="not deprecated">
  4122. </field>
  4123. <field name="SORT_PHASE" type="org.apache.hadoop.mapred.JobHistory.Keys"
  4124. transient="false" volatile="false"
  4125. static="true" final="true" visibility="public"
  4126. deprecated="not deprecated">
  4127. </field>
  4128. <field name="REDUCE_PHASE" type="org.apache.hadoop.mapred.JobHistory.Keys"
  4129. transient="false" volatile="false"
  4130. static="true" final="true" visibility="public"
  4131. deprecated="not deprecated">
  4132. </field>
  4133. <field name="SHUFFLE_FINISHED" type="org.apache.hadoop.mapred.JobHistory.Keys"
  4134. transient="false" volatile="false"
  4135. static="true" final="true" visibility="public"
  4136. deprecated="not deprecated">
  4137. </field>
  4138. <field name="SORT_FINISHED" type="org.apache.hadoop.mapred.JobHistory.Keys"
  4139. transient="false" volatile="false"
  4140. static="true" final="true" visibility="public"
  4141. deprecated="not deprecated">
  4142. </field>
  4143. <field name="COUNTERS" type="org.apache.hadoop.mapred.JobHistory.Keys"
  4144. transient="false" volatile="false"
  4145. static="true" final="true" visibility="public"
  4146. deprecated="not deprecated">
  4147. </field>
  4148. <field name="SPLITS" type="org.apache.hadoop.mapred.JobHistory.Keys"
  4149. transient="false" volatile="false"
  4150. static="true" final="true" visibility="public"
  4151. deprecated="not deprecated">
  4152. </field>
  4153. <field name="JOB_PRIORITY" type="org.apache.hadoop.mapred.JobHistory.Keys"
  4154. transient="false" volatile="false"
  4155. static="true" final="true" visibility="public"
  4156. deprecated="not deprecated">
  4157. </field>
  4158. <field name="HTTP_PORT" type="org.apache.hadoop.mapred.JobHistory.Keys"
  4159. transient="false" volatile="false"
  4160. static="true" final="true" visibility="public"
  4161. deprecated="not deprecated">
  4162. </field>
  4163. <field name="TRACKER_NAME" type="org.apache.hadoop.mapred.JobHistory.Keys"
  4164. transient="false" volatile="false"
  4165. static="true" final="true" visibility="public"
  4166. deprecated="not deprecated">
  4167. </field>
  4168. <field name="STATE_STRING" type="org.apache.hadoop.mapred.JobHistory.Keys"
  4169. transient="false" volatile="false"
  4170. static="true" final="true" visibility="public"
  4171. deprecated="not deprecated">
  4172. </field>
  4173. <field name="VERSION" type="org.apache.hadoop.mapred.JobHistory.Keys"
  4174. transient="false" volatile="false"
  4175. static="true" final="true" visibility="public"
  4176. deprecated="not deprecated">
  4177. </field>
  4178. <doc>
  4179. <![CDATA[Job history files contain key="value" pairs, where keys belong to this enum.
  4180. It acts as a global namespace for all keys.]]>
  4181. </doc>
  4182. </class>
  4183. <!-- end class org.apache.hadoop.mapred.JobHistory.Keys -->
  4184. <!-- start interface org.apache.hadoop.mapred.JobHistory.Listener -->
  4185. <interface name="JobHistory.Listener" abstract="true"
  4186. static="true" final="false" visibility="public"
  4187. deprecated="not deprecated">
  4188. <method name="handle"
  4189. abstract="false" native="false" synchronized="false"
  4190. static="false" final="false" visibility="public"
  4191. deprecated="not deprecated">
  4192. <param name="recType" type="org.apache.hadoop.mapred.JobHistory.RecordTypes"/>
  4193. <param name="values" type="java.util.Map"/>
  4194. <exception name="IOException" type="java.io.IOException"/>
  4195. <doc>
  4196. <![CDATA[Callback method for history parser.
  4197. @param recType type of record, which is the first entry in the line.
  4198. @param values a map of key-value pairs as thry appear in history.
  4199. @throws IOException]]>
  4200. </doc>
  4201. </method>
  4202. <doc>
  4203. <![CDATA[Callback interface for reading back log events from JobHistory. This interface
  4204. should be implemented and passed to JobHistory.parseHistory()]]>
  4205. </doc>
  4206. </interface>
  4207. <!-- end interface org.apache.hadoop.mapred.JobHistory.Listener -->
  4208. <!-- start class org.apache.hadoop.mapred.JobHistory.MapAttempt -->
  4209. <class name="JobHistory.MapAttempt" extends="org.apache.hadoop.mapred.JobHistory.TaskAttempt"
  4210. abstract="false"
  4211. static="true" final="false" visibility="public"
  4212. deprecated="not deprecated">
  4213. <constructor name="JobHistory.MapAttempt"
  4214. static="false" final="false" visibility="public"
  4215. deprecated="not deprecated">
  4216. </constructor>
  4217. <method name="logStarted"
  4218. abstract="false" native="false" synchronized="false"
  4219. static="true" final="false" visibility="public"
  4220. deprecated="Use
  4221. {@link #logStarted(TaskAttemptID, long, String, int, String)}">
  4222. <param name="taskAttemptId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  4223. <param name="startTime" type="long"/>
  4224. <param name="hostName" type="java.lang.String"/>
  4225. <doc>
  4226. <![CDATA[Log start time of this map task attempt.
  4227. @param taskAttemptId task attempt id
  4228. @param startTime start time of task attempt as reported by task tracker.
  4229. @param hostName host name of the task attempt.
  4230. @deprecated Use
  4231. {@link #logStarted(TaskAttemptID, long, String, int, String)}]]>
  4232. </doc>
  4233. </method>
  4234. <method name="logStarted"
  4235. abstract="false" native="false" synchronized="false"
  4236. static="true" final="false" visibility="public"
  4237. deprecated="not deprecated">
  4238. <param name="taskAttemptId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  4239. <param name="startTime" type="long"/>
  4240. <param name="trackerName" type="java.lang.String"/>
  4241. <param name="httpPort" type="int"/>
  4242. <param name="taskType" type="java.lang.String"/>
  4243. <doc>
  4244. <![CDATA[Log start time of this map task attempt.
  4245. @param taskAttemptId task attempt id
  4246. @param startTime start time of task attempt as reported by task tracker.
  4247. @param trackerName name of the tracker executing the task attempt.
  4248. @param httpPort http port of the task tracker executing the task attempt
  4249. @param taskType Whether the attempt is cleanup or setup or map]]>
  4250. </doc>
  4251. </method>
  4252. <method name="logFinished"
  4253. abstract="false" native="false" synchronized="false"
  4254. static="true" final="false" visibility="public"
  4255. deprecated="Use
  4256. {@link #logFinished(TaskAttemptID, long, String, String, String, Counters)}">
  4257. <param name="taskAttemptId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  4258. <param name="finishTime" type="long"/>
  4259. <param name="hostName" type="java.lang.String"/>
  4260. <doc>
  4261. <![CDATA[Log finish time of map task attempt.
  4262. @param taskAttemptId task attempt id
  4263. @param finishTime finish time
  4264. @param hostName host name
  4265. @deprecated Use
  4266. {@link #logFinished(TaskAttemptID, long, String, String, String, Counters)}]]>
  4267. </doc>
  4268. </method>
  4269. <method name="logFinished"
  4270. abstract="false" native="false" synchronized="false"
  4271. static="true" final="false" visibility="public"
  4272. deprecated="not deprecated">
  4273. <param name="taskAttemptId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  4274. <param name="finishTime" type="long"/>
  4275. <param name="hostName" type="java.lang.String"/>
  4276. <param name="taskType" type="java.lang.String"/>
  4277. <param name="stateString" type="java.lang.String"/>
  4278. <param name="counter" type="org.apache.hadoop.mapred.Counters"/>
  4279. <doc>
  4280. <![CDATA[Log finish time of map task attempt.
  4281. @param taskAttemptId task attempt id
  4282. @param finishTime finish time
  4283. @param hostName host name
  4284. @param taskType Whether the attempt is cleanup or setup or map
  4285. @param stateString state string of the task attempt
  4286. @param counter counters of the task attempt]]>
  4287. </doc>
  4288. </method>
  4289. <method name="logFailed"
  4290. abstract="false" native="false" synchronized="false"
  4291. static="true" final="false" visibility="public"
  4292. deprecated="Use
  4293. {@link #logFailed(TaskAttemptID, long, String, String, String)}">
  4294. <param name="taskAttemptId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  4295. <param name="timestamp" type="long"/>
  4296. <param name="hostName" type="java.lang.String"/>
  4297. <param name="error" type="java.lang.String"/>
  4298. <doc>
  4299. <![CDATA[Log task attempt failed event.
  4300. @param taskAttemptId task attempt id
  4301. @param timestamp timestamp
  4302. @param hostName hostname of this task attempt.
  4303. @param error error message if any for this task attempt.
  4304. @deprecated Use
  4305. {@link #logFailed(TaskAttemptID, long, String, String, String)}]]>
  4306. </doc>
  4307. </method>
  4308. <method name="logFailed"
  4309. abstract="false" native="false" synchronized="false"
  4310. static="true" final="false" visibility="public"
  4311. deprecated="not deprecated">
  4312. <param name="taskAttemptId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  4313. <param name="timestamp" type="long"/>
  4314. <param name="hostName" type="java.lang.String"/>
  4315. <param name="error" type="java.lang.String"/>
  4316. <param name="taskType" type="java.lang.String"/>
  4317. <doc>
  4318. <![CDATA[Log task attempt failed event.
  4319. @param taskAttemptId task attempt id
  4320. @param timestamp timestamp
  4321. @param hostName hostname of this task attempt.
  4322. @param error error message if any for this task attempt.
  4323. @param taskType Whether the attempt is cleanup or setup or map]]>
  4324. </doc>
  4325. </method>
  4326. <method name="logKilled"
  4327. abstract="false" native="false" synchronized="false"
  4328. static="true" final="false" visibility="public"
  4329. deprecated="Use
  4330. {@link #logKilled(TaskAttemptID, long, String, String, String)}">
  4331. <param name="taskAttemptId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  4332. <param name="timestamp" type="long"/>
  4333. <param name="hostName" type="java.lang.String"/>
  4334. <param name="error" type="java.lang.String"/>
  4335. <doc>
  4336. <![CDATA[Log task attempt killed event.
  4337. @param taskAttemptId task attempt id
  4338. @param timestamp timestamp
  4339. @param hostName hostname of this task attempt.
  4340. @param error error message if any for this task attempt.
  4341. @deprecated Use
  4342. {@link #logKilled(TaskAttemptID, long, String, String, String)}]]>
  4343. </doc>
  4344. </method>
  4345. <method name="logKilled"
  4346. abstract="false" native="false" synchronized="false"
  4347. static="true" final="false" visibility="public"
  4348. deprecated="not deprecated">
  4349. <param name="taskAttemptId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  4350. <param name="timestamp" type="long"/>
  4351. <param name="hostName" type="java.lang.String"/>
  4352. <param name="error" type="java.lang.String"/>
  4353. <param name="taskType" type="java.lang.String"/>
  4354. <doc>
  4355. <![CDATA[Log task attempt killed event.
  4356. @param taskAttemptId task attempt id
  4357. @param timestamp timestamp
  4358. @param hostName hostname of this task attempt.
  4359. @param error error message if any for this task attempt.
  4360. @param taskType Whether the attempt is cleanup or setup or map]]>
  4361. </doc>
  4362. </method>
  4363. <doc>
  4364. <![CDATA[Helper class for logging or reading back events related to start, finish or failure of
  4365. a Map Attempt on a node.]]>
  4366. </doc>
  4367. </class>
  4368. <!-- end class org.apache.hadoop.mapred.JobHistory.MapAttempt -->
  4369. <!-- start class org.apache.hadoop.mapred.JobHistory.RecordTypes -->
  4370. <class name="JobHistory.RecordTypes" extends="java.lang.Enum"
  4371. abstract="false"
  4372. static="true" final="true" visibility="public"
  4373. deprecated="not deprecated">
  4374. <method name="values" return="org.apache.hadoop.mapred.JobHistory.RecordTypes[]"
  4375. abstract="false" native="false" synchronized="false"
  4376. static="true" final="false" visibility="public"
  4377. deprecated="not deprecated">
  4378. </method>
  4379. <method name="valueOf" return="org.apache.hadoop.mapred.JobHistory.RecordTypes"
  4380. abstract="false" native="false" synchronized="false"
  4381. static="true" final="false" visibility="public"
  4382. deprecated="not deprecated">
  4383. <param name="name" type="java.lang.String"/>
  4384. </method>
  4385. <field name="Jobtracker" type="org.apache.hadoop.mapred.JobHistory.RecordTypes"
  4386. transient="false" volatile="false"
  4387. static="true" final="true" visibility="public"
  4388. deprecated="not deprecated">
  4389. </field>
  4390. <field name="Job" type="org.apache.hadoop.mapred.JobHistory.RecordTypes"
  4391. transient="false" volatile="false"
  4392. static="true" final="true" visibility="public"
  4393. deprecated="not deprecated">
  4394. </field>
  4395. <field name="Task" type="org.apache.hadoop.mapred.JobHistory.RecordTypes"
  4396. transient="false" volatile="false"
  4397. static="true" final="true" visibility="public"
  4398. deprecated="not deprecated">
  4399. </field>
  4400. <field name="MapAttempt" type="org.apache.hadoop.mapred.JobHistory.RecordTypes"
  4401. transient="false" volatile="false"
  4402. static="true" final="true" visibility="public"
  4403. deprecated="not deprecated">
  4404. </field>
  4405. <field name="ReduceAttempt" type="org.apache.hadoop.mapred.JobHistory.RecordTypes"
  4406. transient="false" volatile="false"
  4407. static="true" final="true" visibility="public"
  4408. deprecated="not deprecated">
  4409. </field>
  4410. <field name="Meta" type="org.apache.hadoop.mapred.JobHistory.RecordTypes"
  4411. transient="false" volatile="false"
  4412. static="true" final="true" visibility="public"
  4413. deprecated="not deprecated">
  4414. </field>
  4415. <doc>
  4416. <![CDATA[Record types are identifiers for each line of log in history files.
  4417. A record type appears as the first token in a single line of log.]]>
  4418. </doc>
  4419. </class>
  4420. <!-- end class org.apache.hadoop.mapred.JobHistory.RecordTypes -->
  4421. <!-- start class org.apache.hadoop.mapred.JobHistory.ReduceAttempt -->
  4422. <class name="JobHistory.ReduceAttempt" extends="org.apache.hadoop.mapred.JobHistory.TaskAttempt"
  4423. abstract="false"
  4424. static="true" final="false" visibility="public"
  4425. deprecated="not deprecated">
  4426. <constructor name="JobHistory.ReduceAttempt"
  4427. static="false" final="false" visibility="public"
  4428. deprecated="not deprecated">
  4429. </constructor>
  4430. <method name="logStarted"
  4431. abstract="false" native="false" synchronized="false"
  4432. static="true" final="false" visibility="public"
  4433. deprecated="Use
  4434. {@link #logStarted(TaskAttemptID, long, String, int, String)}">
  4435. <param name="taskAttemptId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  4436. <param name="startTime" type="long"/>
  4437. <param name="hostName" type="java.lang.String"/>
  4438. <doc>
  4439. <![CDATA[Log start time of Reduce task attempt.
  4440. @param taskAttemptId task attempt id
  4441. @param startTime start time
  4442. @param hostName host name
  4443. @deprecated Use
  4444. {@link #logStarted(TaskAttemptID, long, String, int, String)}]]>
  4445. </doc>
  4446. </method>
  4447. <method name="logStarted"
  4448. abstract="false" native="false" synchronized="false"
  4449. static="true" final="false" visibility="public"
  4450. deprecated="not deprecated">
  4451. <param name="taskAttemptId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  4452. <param name="startTime" type="long"/>
  4453. <param name="trackerName" type="java.lang.String"/>
  4454. <param name="httpPort" type="int"/>
  4455. <param name="taskType" type="java.lang.String"/>
  4456. <doc>
  4457. <![CDATA[Log start time of Reduce task attempt.
  4458. @param taskAttemptId task attempt id
  4459. @param startTime start time
  4460. @param trackerName tracker name
  4461. @param httpPort the http port of the tracker executing the task attempt
  4462. @param taskType Whether the attempt is cleanup or setup or reduce]]>
  4463. </doc>
  4464. </method>
  4465. <method name="logFinished"
  4466. abstract="false" native="false" synchronized="false"
  4467. static="true" final="false" visibility="public"
  4468. deprecated="Use
  4469. {@link #logFinished(TaskAttemptID, long, long, long, String, String, String, Counters)}">
  4470. <param name="taskAttemptId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  4471. <param name="shuffleFinished" type="long"/>
  4472. <param name="sortFinished" type="long"/>
  4473. <param name="finishTime" type="long"/>
  4474. <param name="hostName" type="java.lang.String"/>
  4475. <doc>
  4476. <![CDATA[Log finished event of this task.
  4477. @param taskAttemptId task attempt id
  4478. @param shuffleFinished shuffle finish time
  4479. @param sortFinished sort finish time
  4480. @param finishTime finish time of task
  4481. @param hostName host name where task attempt executed
  4482. @deprecated Use
  4483. {@link #logFinished(TaskAttemptID, long, long, long, String, String, String, Counters)}]]>
  4484. </doc>
  4485. </method>
  4486. <method name="logFinished"
  4487. abstract="false" native="false" synchronized="false"
  4488. static="true" final="false" visibility="public"
  4489. deprecated="not deprecated">
  4490. <param name="taskAttemptId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  4491. <param name="shuffleFinished" type="long"/>
  4492. <param name="sortFinished" type="long"/>
  4493. <param name="finishTime" type="long"/>
  4494. <param name="hostName" type="java.lang.String"/>
  4495. <param name="taskType" type="java.lang.String"/>
  4496. <param name="stateString" type="java.lang.String"/>
  4497. <param name="counter" type="org.apache.hadoop.mapred.Counters"/>
  4498. <doc>
  4499. <![CDATA[Log finished event of this task.
  4500. @param taskAttemptId task attempt id
  4501. @param shuffleFinished shuffle finish time
  4502. @param sortFinished sort finish time
  4503. @param finishTime finish time of task
  4504. @param hostName host name where task attempt executed
  4505. @param taskType Whether the attempt is cleanup or setup or reduce
  4506. @param stateString the state string of the attempt
  4507. @param counter counters of the attempt]]>
  4508. </doc>
  4509. </method>
  4510. <method name="logFailed"
  4511. abstract="false" native="false" synchronized="false"
  4512. static="true" final="false" visibility="public"
  4513. deprecated="Use
  4514. {@link #logFailed(TaskAttemptID, long, String, String, String)}">
  4515. <param name="taskAttemptId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  4516. <param name="timestamp" type="long"/>
  4517. <param name="hostName" type="java.lang.String"/>
  4518. <param name="error" type="java.lang.String"/>
  4519. <doc>
  4520. <![CDATA[Log failed reduce task attempt.
  4521. @param taskAttemptId task attempt id
  4522. @param timestamp time stamp when task failed
  4523. @param hostName host name of the task attempt.
  4524. @param error error message of the task.
  4525. @deprecated Use
  4526. {@link #logFailed(TaskAttemptID, long, String, String, String)}]]>
  4527. </doc>
  4528. </method>
  4529. <method name="logFailed"
  4530. abstract="false" native="false" synchronized="false"
  4531. static="true" final="false" visibility="public"
  4532. deprecated="not deprecated">
  4533. <param name="taskAttemptId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  4534. <param name="timestamp" type="long"/>
  4535. <param name="hostName" type="java.lang.String"/>
  4536. <param name="error" type="java.lang.String"/>
  4537. <param name="taskType" type="java.lang.String"/>
  4538. <doc>
  4539. <![CDATA[Log failed reduce task attempt.
  4540. @param taskAttemptId task attempt id
  4541. @param timestamp time stamp when task failed
  4542. @param hostName host name of the task attempt.
  4543. @param error error message of the task.
  4544. @param taskType Whether the attempt is cleanup or setup or reduce]]>
  4545. </doc>
  4546. </method>
  4547. <method name="logKilled"
  4548. abstract="false" native="false" synchronized="false"
  4549. static="true" final="false" visibility="public"
  4550. deprecated="Use
  4551. {@link #logKilled(TaskAttemptID, long, String, String, String)}">
  4552. <param name="taskAttemptId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  4553. <param name="timestamp" type="long"/>
  4554. <param name="hostName" type="java.lang.String"/>
  4555. <param name="error" type="java.lang.String"/>
  4556. <doc>
  4557. <![CDATA[Log killed reduce task attempt.
  4558. @param taskAttemptId task attempt id
  4559. @param timestamp time stamp when task failed
  4560. @param hostName host name of the task attempt.
  4561. @param error error message of the task.
  4562. @deprecated Use
  4563. {@link #logKilled(TaskAttemptID, long, String, String, String)}]]>
  4564. </doc>
  4565. </method>
  4566. <method name="logKilled"
  4567. abstract="false" native="false" synchronized="false"
  4568. static="true" final="false" visibility="public"
  4569. deprecated="not deprecated">
  4570. <param name="taskAttemptId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  4571. <param name="timestamp" type="long"/>
  4572. <param name="hostName" type="java.lang.String"/>
  4573. <param name="error" type="java.lang.String"/>
  4574. <param name="taskType" type="java.lang.String"/>
  4575. <doc>
  4576. <![CDATA[Log killed reduce task attempt.
  4577. @param taskAttemptId task attempt id
  4578. @param timestamp time stamp when task failed
  4579. @param hostName host name of the task attempt.
  4580. @param error error message of the task.
  4581. @param taskType Whether the attempt is cleanup or setup or reduce]]>
  4582. </doc>
  4583. </method>
  4584. <doc>
  4585. <![CDATA[Helper class for logging or reading back events related to start, finish or failure of
  4586. a Map Attempt on a node.]]>
  4587. </doc>
  4588. </class>
  4589. <!-- end class org.apache.hadoop.mapred.JobHistory.ReduceAttempt -->
  4590. <!-- start class org.apache.hadoop.mapred.JobHistory.Task -->
  4591. <class name="JobHistory.Task" extends="org.apache.hadoop.mapred.JobHistory.KeyValuePair"
  4592. abstract="false"
  4593. static="true" final="false" visibility="public"
  4594. deprecated="not deprecated">
  4595. <constructor name="JobHistory.Task"
  4596. static="false" final="false" visibility="public"
  4597. deprecated="not deprecated">
  4598. </constructor>
  4599. <method name="logStarted"
  4600. abstract="false" native="false" synchronized="false"
  4601. static="true" final="false" visibility="public"
  4602. deprecated="not deprecated">
  4603. <param name="taskId" type="org.apache.hadoop.mapred.TaskID"/>
  4604. <param name="taskType" type="java.lang.String"/>
  4605. <param name="startTime" type="long"/>
  4606. <param name="splitLocations" type="java.lang.String"/>
  4607. <doc>
  4608. <![CDATA[Log start time of task (TIP).
  4609. @param taskId task id
  4610. @param taskType MAP or REDUCE
  4611. @param startTime startTime of tip.]]>
  4612. </doc>
  4613. </method>
  4614. <method name="logFinished"
  4615. abstract="false" native="false" synchronized="false"
  4616. static="true" final="false" visibility="public"
  4617. deprecated="not deprecated">
  4618. <param name="taskId" type="org.apache.hadoop.mapred.TaskID"/>
  4619. <param name="taskType" type="java.lang.String"/>
  4620. <param name="finishTime" type="long"/>
  4621. <param name="counters" type="org.apache.hadoop.mapred.Counters"/>
  4622. <doc>
  4623. <![CDATA[Log finish time of task.
  4624. @param taskId task id
  4625. @param taskType MAP or REDUCE
  4626. @param finishTime finish timeof task in ms]]>
  4627. </doc>
  4628. </method>
  4629. <method name="logUpdates"
  4630. abstract="false" native="false" synchronized="false"
  4631. static="true" final="false" visibility="public"
  4632. deprecated="not deprecated">
  4633. <param name="taskId" type="org.apache.hadoop.mapred.TaskID"/>
  4634. <param name="finishTime" type="long"/>
  4635. <doc>
  4636. <![CDATA[Update the finish time of task.
  4637. @param taskId task id
  4638. @param finishTime finish time of task in ms]]>
  4639. </doc>
  4640. </method>
  4641. <method name="logFailed"
  4642. abstract="false" native="false" synchronized="false"
  4643. static="true" final="false" visibility="public"
  4644. deprecated="not deprecated">
  4645. <param name="taskId" type="org.apache.hadoop.mapred.TaskID"/>
  4646. <param name="taskType" type="java.lang.String"/>
  4647. <param name="time" type="long"/>
  4648. <param name="error" type="java.lang.String"/>
  4649. <doc>
  4650. <![CDATA[Log job failed event.
  4651. @param taskId task id
  4652. @param taskType MAP or REDUCE.
  4653. @param time timestamp when job failed detected.
  4654. @param error error message for failure.]]>
  4655. </doc>
  4656. </method>
  4657. <method name="logFailed"
  4658. abstract="false" native="false" synchronized="false"
  4659. static="true" final="false" visibility="public"
  4660. deprecated="not deprecated">
  4661. <param name="taskId" type="org.apache.hadoop.mapred.TaskID"/>
  4662. <param name="taskType" type="java.lang.String"/>
  4663. <param name="time" type="long"/>
  4664. <param name="error" type="java.lang.String"/>
  4665. <param name="failedDueToAttempt" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  4666. <doc>
  4667. <![CDATA[@param failedDueToAttempt The attempt that caused the failure, if any]]>
  4668. </doc>
  4669. </method>
  4670. <method name="getTaskAttempts" return="java.util.Map"
  4671. abstract="false" native="false" synchronized="false"
  4672. static="false" final="false" visibility="public"
  4673. deprecated="not deprecated">
  4674. <doc>
  4675. <![CDATA[Returns all task attempts for this task. <task attempt id - TaskAttempt>]]>
  4676. </doc>
  4677. </method>
  4678. <doc>
  4679. <![CDATA[Helper class for logging or reading back events related to Task's start, finish or failure.
  4680. All events logged by this class are logged in a separate file per job in
  4681. job tracker history. These events map to TIPs in jobtracker.]]>
  4682. </doc>
  4683. </class>
  4684. <!-- end class org.apache.hadoop.mapred.JobHistory.Task -->
  4685. <!-- start class org.apache.hadoop.mapred.JobHistory.TaskAttempt -->
  4686. <class name="JobHistory.TaskAttempt" extends="org.apache.hadoop.mapred.JobHistory.Task"
  4687. abstract="false"
  4688. static="true" final="false" visibility="public"
  4689. deprecated="not deprecated">
  4690. <constructor name="JobHistory.TaskAttempt"
  4691. static="false" final="false" visibility="public"
  4692. deprecated="not deprecated">
  4693. </constructor>
  4694. <doc>
  4695. <![CDATA[Base class for Map and Reduce TaskAttempts.]]>
  4696. </doc>
  4697. </class>
  4698. <!-- end class org.apache.hadoop.mapred.JobHistory.TaskAttempt -->
  4699. <!-- start class org.apache.hadoop.mapred.JobHistory.Values -->
  4700. <class name="JobHistory.Values" extends="java.lang.Enum"
  4701. abstract="false"
  4702. static="true" final="true" visibility="public"
  4703. deprecated="not deprecated">
  4704. <method name="values" return="org.apache.hadoop.mapred.JobHistory.Values[]"
  4705. abstract="false" native="false" synchronized="false"
  4706. static="true" final="false" visibility="public"
  4707. deprecated="not deprecated">
  4708. </method>
  4709. <method name="valueOf" return="org.apache.hadoop.mapred.JobHistory.Values"
  4710. abstract="false" native="false" synchronized="false"
  4711. static="true" final="false" visibility="public"
  4712. deprecated="not deprecated">
  4713. <param name="name" type="java.lang.String"/>
  4714. </method>
  4715. <field name="SUCCESS" type="org.apache.hadoop.mapred.JobHistory.Values"
  4716. transient="false" volatile="false"
  4717. static="true" final="true" visibility="public"
  4718. deprecated="not deprecated">
  4719. </field>
  4720. <field name="FAILED" type="org.apache.hadoop.mapred.JobHistory.Values"
  4721. transient="false" volatile="false"
  4722. static="true" final="true" visibility="public"
  4723. deprecated="not deprecated">
  4724. </field>
  4725. <field name="KILLED" type="org.apache.hadoop.mapred.JobHistory.Values"
  4726. transient="false" volatile="false"
  4727. static="true" final="true" visibility="public"
  4728. deprecated="not deprecated">
  4729. </field>
  4730. <field name="MAP" type="org.apache.hadoop.mapred.JobHistory.Values"
  4731. transient="false" volatile="false"
  4732. static="true" final="true" visibility="public"
  4733. deprecated="not deprecated">
  4734. </field>
  4735. <field name="REDUCE" type="org.apache.hadoop.mapred.JobHistory.Values"
  4736. transient="false" volatile="false"
  4737. static="true" final="true" visibility="public"
  4738. deprecated="not deprecated">
  4739. </field>
  4740. <field name="CLEANUP" type="org.apache.hadoop.mapred.JobHistory.Values"
  4741. transient="false" volatile="false"
  4742. static="true" final="true" visibility="public"
  4743. deprecated="not deprecated">
  4744. </field>
  4745. <field name="RUNNING" type="org.apache.hadoop.mapred.JobHistory.Values"
  4746. transient="false" volatile="false"
  4747. static="true" final="true" visibility="public"
  4748. deprecated="not deprecated">
  4749. </field>
  4750. <field name="PREP" type="org.apache.hadoop.mapred.JobHistory.Values"
  4751. transient="false" volatile="false"
  4752. static="true" final="true" visibility="public"
  4753. deprecated="not deprecated">
  4754. </field>
  4755. <field name="SETUP" type="org.apache.hadoop.mapred.JobHistory.Values"
  4756. transient="false" volatile="false"
  4757. static="true" final="true" visibility="public"
  4758. deprecated="not deprecated">
  4759. </field>
  4760. <doc>
  4761. <![CDATA[This enum contains some of the values commonly used by history log events.
  4762. since values in history can only be strings - Values.name() is used in
  4763. most places in history file.]]>
  4764. </doc>
  4765. </class>
  4766. <!-- end class org.apache.hadoop.mapred.JobHistory.Values -->
  4767. <!-- start class org.apache.hadoop.mapred.JobID -->
  4768. <class name="JobID" extends="org.apache.hadoop.mapreduce.JobID"
  4769. abstract="false"
  4770. static="false" final="false" visibility="public"
  4771. deprecated="not deprecated">
  4772. <constructor name="JobID" type="java.lang.String, int"
  4773. static="false" final="false" visibility="public"
  4774. deprecated="not deprecated">
  4775. <doc>
  4776. <![CDATA[Constructs a JobID object
  4777. @param jtIdentifier jobTracker identifier
  4778. @param id job number]]>
  4779. </doc>
  4780. </constructor>
  4781. <constructor name="JobID"
  4782. static="false" final="false" visibility="public"
  4783. deprecated="not deprecated">
  4784. </constructor>
  4785. <method name="downgrade" return="org.apache.hadoop.mapred.JobID"
  4786. abstract="false" native="false" synchronized="false"
  4787. static="true" final="false" visibility="public"
  4788. deprecated="not deprecated">
  4789. <param name="old" type="org.apache.hadoop.mapreduce.JobID"/>
  4790. <doc>
  4791. <![CDATA[Downgrade a new JobID to an old one
  4792. @param old a new or old JobID
  4793. @return either old or a new JobID build to match old]]>
  4794. </doc>
  4795. </method>
  4796. <method name="read" return="org.apache.hadoop.mapred.JobID"
  4797. abstract="false" native="false" synchronized="false"
  4798. static="true" final="false" visibility="public"
  4799. deprecated="not deprecated">
  4800. <param name="in" type="java.io.DataInput"/>
  4801. <exception name="IOException" type="java.io.IOException"/>
  4802. </method>
  4803. <method name="forName" return="org.apache.hadoop.mapred.JobID"
  4804. abstract="false" native="false" synchronized="false"
  4805. static="true" final="false" visibility="public"
  4806. deprecated="not deprecated">
  4807. <param name="str" type="java.lang.String"/>
  4808. <exception name="IllegalArgumentException" type="java.lang.IllegalArgumentException"/>
  4809. <doc>
  4810. <![CDATA[Construct a JobId object from given string
  4811. @return constructed JobId object or null if the given String is null
  4812. @throws IllegalArgumentException if the given string is malformed]]>
  4813. </doc>
  4814. </method>
  4815. <method name="getJobIDsPattern" return="java.lang.String"
  4816. abstract="false" native="false" synchronized="false"
  4817. static="true" final="false" visibility="public"
  4818. deprecated="not deprecated">
  4819. <param name="jtIdentifier" type="java.lang.String"/>
  4820. <param name="jobId" type="java.lang.Integer"/>
  4821. <doc>
  4822. <![CDATA[Returns a regex pattern which matches task IDs. Arguments can
  4823. be given null, in which case that part of the regex will be generic.
  4824. For example to obtain a regex matching <i>any job</i>
  4825. run on the jobtracker started at <i>200707121733</i>, we would use :
  4826. <pre>
  4827. JobID.getTaskIDsPattern("200707121733", null);
  4828. </pre>
  4829. which will return :
  4830. <pre> "job_200707121733_[0-9]*" </pre>
  4831. @param jtIdentifier jobTracker identifier, or null
  4832. @param jobId job number, or null
  4833. @return a regex pattern matching JobIDs]]>
  4834. </doc>
  4835. </method>
  4836. <doc>
  4837. <![CDATA[JobID represents the immutable and unique identifier for
  4838. the job. JobID consists of two parts. First part
  4839. represents the jobtracker identifier, so that jobID to jobtracker map
  4840. is defined. For cluster setup this string is the jobtracker
  4841. start time, for local setting, it is "local".
  4842. Second part of the JobID is the job number. <br>
  4843. An example JobID is :
  4844. <code>job_200707121733_0003</code> , which represents the third job
  4845. running at the jobtracker started at <code>200707121733</code>.
  4846. <p>
  4847. Applications should never construct or parse JobID strings, but rather
  4848. use appropriate constructors or {@link #forName(String)} method.
  4849. @see TaskID
  4850. @see TaskAttemptID]]>
  4851. </doc>
  4852. </class>
  4853. <!-- end class org.apache.hadoop.mapred.JobID -->
  4854. <!-- start class org.apache.hadoop.mapred.JobPriority -->
  4855. <class name="JobPriority" extends="java.lang.Enum"
  4856. abstract="false"
  4857. static="false" final="true" visibility="public"
  4858. deprecated="not deprecated">
  4859. <method name="values" return="org.apache.hadoop.mapred.JobPriority[]"
  4860. abstract="false" native="false" synchronized="false"
  4861. static="true" final="false" visibility="public"
  4862. deprecated="not deprecated">
  4863. </method>
  4864. <method name="valueOf" return="org.apache.hadoop.mapred.JobPriority"
  4865. abstract="false" native="false" synchronized="false"
  4866. static="true" final="false" visibility="public"
  4867. deprecated="not deprecated">
  4868. <param name="name" type="java.lang.String"/>
  4869. </method>
  4870. <field name="VERY_HIGH" type="org.apache.hadoop.mapred.JobPriority"
  4871. transient="false" volatile="false"
  4872. static="true" final="true" visibility="public"
  4873. deprecated="not deprecated">
  4874. </field>
  4875. <field name="HIGH" type="org.apache.hadoop.mapred.JobPriority"
  4876. transient="false" volatile="false"
  4877. static="true" final="true" visibility="public"
  4878. deprecated="not deprecated">
  4879. </field>
  4880. <field name="NORMAL" type="org.apache.hadoop.mapred.JobPriority"
  4881. transient="false" volatile="false"
  4882. static="true" final="true" visibility="public"
  4883. deprecated="not deprecated">
  4884. </field>
  4885. <field name="LOW" type="org.apache.hadoop.mapred.JobPriority"
  4886. transient="false" volatile="false"
  4887. static="true" final="true" visibility="public"
  4888. deprecated="not deprecated">
  4889. </field>
  4890. <field name="VERY_LOW" type="org.apache.hadoop.mapred.JobPriority"
  4891. transient="false" volatile="false"
  4892. static="true" final="true" visibility="public"
  4893. deprecated="not deprecated">
  4894. </field>
  4895. <doc>
  4896. <![CDATA[Used to describe the priority of the running job.]]>
  4897. </doc>
  4898. </class>
  4899. <!-- end class org.apache.hadoop.mapred.JobPriority -->
  4900. <!-- start class org.apache.hadoop.mapred.JobProfile -->
  4901. <class name="JobProfile" extends="java.lang.Object"
  4902. abstract="false"
  4903. static="false" final="false" visibility="public"
  4904. deprecated="not deprecated">
  4905. <implements name="org.apache.hadoop.io.Writable"/>
  4906. <constructor name="JobProfile"
  4907. static="false" final="false" visibility="public"
  4908. deprecated="not deprecated">
  4909. <doc>
  4910. <![CDATA[Construct an empty {@link JobProfile}.]]>
  4911. </doc>
  4912. </constructor>
  4913. <constructor name="JobProfile" type="java.lang.String, org.apache.hadoop.mapreduce.JobID, java.lang.String, java.lang.String, java.lang.String"
  4914. static="false" final="false" visibility="public"
  4915. deprecated="not deprecated">
  4916. <doc>
  4917. <![CDATA[Construct a {@link JobProfile} the userid, jobid,
  4918. job config-file, job-details url and job name.
  4919. @param user userid of the person who submitted the job.
  4920. @param jobid id of the job.
  4921. @param jobFile job configuration file.
  4922. @param url link to the web-ui for details of the job.
  4923. @param name user-specified job name.]]>
  4924. </doc>
  4925. </constructor>
  4926. <constructor name="JobProfile" type="java.lang.String, org.apache.hadoop.mapreduce.JobID, java.lang.String, java.lang.String, java.lang.String, java.lang.String"
  4927. static="false" final="false" visibility="public"
  4928. deprecated="not deprecated">
  4929. <doc>
  4930. <![CDATA[Construct a {@link JobProfile} the userid, jobid,
  4931. job config-file, job-details url and job name.
  4932. @param user userid of the person who submitted the job.
  4933. @param jobid id of the job.
  4934. @param jobFile job configuration file.
  4935. @param url link to the web-ui for details of the job.
  4936. @param name user-specified job name.
  4937. @param queueName name of the queue to which the job is submitted]]>
  4938. </doc>
  4939. </constructor>
  4940. <constructor name="JobProfile" type="java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String"
  4941. static="false" final="false" visibility="public"
  4942. deprecated="use JobProfile(String, JobID, String, String, String) instead">
  4943. <doc>
  4944. <![CDATA[@deprecated use JobProfile(String, JobID, String, String, String) instead]]>
  4945. </doc>
  4946. </constructor>
  4947. <method name="getUser" return="java.lang.String"
  4948. abstract="false" native="false" synchronized="false"
  4949. static="false" final="false" visibility="public"
  4950. deprecated="not deprecated">
  4951. <doc>
  4952. <![CDATA[Get the user id.]]>
  4953. </doc>
  4954. </method>
  4955. <method name="getJobID" return="org.apache.hadoop.mapred.JobID"
  4956. abstract="false" native="false" synchronized="false"
  4957. static="false" final="false" visibility="public"
  4958. deprecated="not deprecated">
  4959. <doc>
  4960. <![CDATA[Get the job id.]]>
  4961. </doc>
  4962. </method>
  4963. <method name="getJobId" return="java.lang.String"
  4964. abstract="false" native="false" synchronized="false"
  4965. static="false" final="false" visibility="public"
  4966. deprecated="use getJobID() instead">
  4967. <doc>
  4968. <![CDATA[@deprecated use getJobID() instead]]>
  4969. </doc>
  4970. </method>
  4971. <method name="getJobFile" return="java.lang.String"
  4972. abstract="false" native="false" synchronized="false"
  4973. static="false" final="false" visibility="public"
  4974. deprecated="not deprecated">
  4975. <doc>
  4976. <![CDATA[Get the configuration file for the job.]]>
  4977. </doc>
  4978. </method>
  4979. <method name="getURL" return="java.net.URL"
  4980. abstract="false" native="false" synchronized="false"
  4981. static="false" final="false" visibility="public"
  4982. deprecated="not deprecated">
  4983. <doc>
  4984. <![CDATA[Get the link to the web-ui for details of the job.]]>
  4985. </doc>
  4986. </method>
  4987. <method name="getJobName" return="java.lang.String"
  4988. abstract="false" native="false" synchronized="false"
  4989. static="false" final="false" visibility="public"
  4990. deprecated="not deprecated">
  4991. <doc>
  4992. <![CDATA[Get the user-specified job name.]]>
  4993. </doc>
  4994. </method>
  4995. <method name="getQueueName" return="java.lang.String"
  4996. abstract="false" native="false" synchronized="false"
  4997. static="false" final="false" visibility="public"
  4998. deprecated="not deprecated">
  4999. <doc>
  5000. <![CDATA[Get the name of the queue to which the job is submitted.
  5001. @return name of the queue.]]>
  5002. </doc>
  5003. </method>
  5004. <method name="write"
  5005. abstract="false" native="false" synchronized="false"
  5006. static="false" final="false" visibility="public"
  5007. deprecated="not deprecated">
  5008. <param name="out" type="java.io.DataOutput"/>
  5009. <exception name="IOException" type="java.io.IOException"/>
  5010. </method>
  5011. <method name="readFields"
  5012. abstract="false" native="false" synchronized="false"
  5013. static="false" final="false" visibility="public"
  5014. deprecated="not deprecated">
  5015. <param name="in" type="java.io.DataInput"/>
  5016. <exception name="IOException" type="java.io.IOException"/>
  5017. </method>
  5018. <doc>
  5019. <![CDATA[A JobProfile is a MapReduce primitive. Tracks a job,
  5020. whether living or dead.]]>
  5021. </doc>
  5022. </class>
  5023. <!-- end class org.apache.hadoop.mapred.JobProfile -->
  5024. <!-- start class org.apache.hadoop.mapred.JobQueueInfo -->
  5025. <class name="JobQueueInfo" extends="java.lang.Object"
  5026. abstract="false"
  5027. static="false" final="false" visibility="public"
  5028. deprecated="not deprecated">
  5029. <implements name="org.apache.hadoop.io.Writable"/>
  5030. <constructor name="JobQueueInfo"
  5031. static="false" final="false" visibility="public"
  5032. deprecated="not deprecated">
  5033. <doc>
  5034. <![CDATA[Default constructor for Job Queue Info.]]>
  5035. </doc>
  5036. </constructor>
  5037. <constructor name="JobQueueInfo" type="java.lang.String, java.lang.String"
  5038. static="false" final="false" visibility="public"
  5039. deprecated="not deprecated">
  5040. <doc>
  5041. <![CDATA[Construct a new JobQueueInfo object using the queue name and the
  5042. scheduling information passed.
  5043. @param queueName Name of the job queue
  5044. @param schedulingInfo Scheduling Information associated with the job
  5045. queue]]>
  5046. </doc>
  5047. </constructor>
  5048. <method name="setQueueName"
  5049. abstract="false" native="false" synchronized="false"
  5050. static="false" final="false" visibility="public"
  5051. deprecated="not deprecated">
  5052. <param name="queueName" type="java.lang.String"/>
  5053. <doc>
  5054. <![CDATA[Set the queue name of the JobQueueInfo
  5055. @param queueName Name of the job queue.]]>
  5056. </doc>
  5057. </method>
  5058. <method name="getQueueName" return="java.lang.String"
  5059. abstract="false" native="false" synchronized="false"
  5060. static="false" final="false" visibility="public"
  5061. deprecated="not deprecated">
  5062. <doc>
  5063. <![CDATA[Get the queue name from JobQueueInfo
  5064. @return queue name]]>
  5065. </doc>
  5066. </method>
  5067. <method name="setSchedulingInfo"
  5068. abstract="false" native="false" synchronized="false"
  5069. static="false" final="false" visibility="public"
  5070. deprecated="not deprecated">
  5071. <param name="schedulingInfo" type="java.lang.String"/>
  5072. <doc>
  5073. <![CDATA[Set the scheduling information associated to particular job queue
  5074. @param schedulingInfo]]>
  5075. </doc>
  5076. </method>
  5077. <method name="getSchedulingInfo" return="java.lang.String"
  5078. abstract="false" native="false" synchronized="false"
  5079. static="false" final="false" visibility="public"
  5080. deprecated="not deprecated">
  5081. <doc>
  5082. <![CDATA[Gets the scheduling information associated to particular job queue.
  5083. If nothing is set would return <b>"N/A"</b>
  5084. @return Scheduling information associated to particular Job Queue]]>
  5085. </doc>
  5086. </method>
  5087. <method name="readFields"
  5088. abstract="false" native="false" synchronized="false"
  5089. static="false" final="false" visibility="public"
  5090. deprecated="not deprecated">
  5091. <param name="in" type="java.io.DataInput"/>
  5092. <exception name="IOException" type="java.io.IOException"/>
  5093. </method>
  5094. <method name="write"
  5095. abstract="false" native="false" synchronized="false"
  5096. static="false" final="false" visibility="public"
  5097. deprecated="not deprecated">
  5098. <param name="out" type="java.io.DataOutput"/>
  5099. <exception name="IOException" type="java.io.IOException"/>
  5100. </method>
  5101. <doc>
  5102. <![CDATA[Class that contains the information regarding the Job Queues which are
  5103. maintained by the Hadoop Map/Reduce framework.]]>
  5104. </doc>
  5105. </class>
  5106. <!-- end class org.apache.hadoop.mapred.JobQueueInfo -->
  5107. <!-- start class org.apache.hadoop.mapred.JobStatus -->
  5108. <class name="JobStatus" extends="java.lang.Object"
  5109. abstract="false"
  5110. static="false" final="false" visibility="public"
  5111. deprecated="not deprecated">
  5112. <implements name="org.apache.hadoop.io.Writable"/>
  5113. <implements name="java.lang.Cloneable"/>
  5114. <constructor name="JobStatus"
  5115. static="false" final="false" visibility="public"
  5116. deprecated="not deprecated">
  5117. </constructor>
  5118. <constructor name="JobStatus" type="org.apache.hadoop.mapred.JobID, float, float, float, int"
  5119. static="false" final="false" visibility="public"
  5120. deprecated="not deprecated">
  5121. <doc>
  5122. <![CDATA[Create a job status object for a given jobid.
  5123. @param jobid The jobid of the job
  5124. @param mapProgress The progress made on the maps
  5125. @param reduceProgress The progress made on the reduces
  5126. @param cleanupProgress The progress made on cleanup
  5127. @param runState The current state of the job]]>
  5128. </doc>
  5129. </constructor>
  5130. <constructor name="JobStatus" type="org.apache.hadoop.mapred.JobID, float, float, int"
  5131. static="false" final="false" visibility="public"
  5132. deprecated="not deprecated">
  5133. <doc>
  5134. <![CDATA[Create a job status object for a given jobid.
  5135. @param jobid The jobid of the job
  5136. @param mapProgress The progress made on the maps
  5137. @param reduceProgress The progress made on the reduces
  5138. @param runState The current state of the job]]>
  5139. </doc>
  5140. </constructor>
  5141. <constructor name="JobStatus" type="org.apache.hadoop.mapred.JobID, float, float, float, int, org.apache.hadoop.mapred.JobPriority"
  5142. static="false" final="false" visibility="public"
  5143. deprecated="not deprecated">
  5144. <doc>
  5145. <![CDATA[Create a job status object for a given jobid.
  5146. @param jobid The jobid of the job
  5147. @param mapProgress The progress made on the maps
  5148. @param reduceProgress The progress made on the reduces
  5149. @param runState The current state of the job
  5150. @param jp Priority of the job.]]>
  5151. </doc>
  5152. </constructor>
  5153. <constructor name="JobStatus" type="org.apache.hadoop.mapred.JobID, float, float, float, float, int, org.apache.hadoop.mapred.JobPriority"
  5154. static="false" final="false" visibility="public"
  5155. deprecated="not deprecated">
  5156. <doc>
  5157. <![CDATA[Create a job status object for a given jobid.
  5158. @param jobid The jobid of the job
  5159. @param setupProgress The progress made on the setup
  5160. @param mapProgress The progress made on the maps
  5161. @param reduceProgress The progress made on the reduces
  5162. @param cleanupProgress The progress made on the cleanup
  5163. @param runState The current state of the job
  5164. @param jp Priority of the job.]]>
  5165. </doc>
  5166. </constructor>
  5167. <method name="getJobId" return="java.lang.String"
  5168. abstract="false" native="false" synchronized="false"
  5169. static="false" final="false" visibility="public"
  5170. deprecated="use getJobID instead">
  5171. <doc>
  5172. <![CDATA[@deprecated use getJobID instead]]>
  5173. </doc>
  5174. </method>
  5175. <method name="getJobID" return="org.apache.hadoop.mapred.JobID"
  5176. abstract="false" native="false" synchronized="false"
  5177. static="false" final="false" visibility="public"
  5178. deprecated="not deprecated">
  5179. <doc>
  5180. <![CDATA[@return The jobid of the Job]]>
  5181. </doc>
  5182. </method>
  5183. <method name="mapProgress" return="float"
  5184. abstract="false" native="false" synchronized="true"
  5185. static="false" final="false" visibility="public"
  5186. deprecated="not deprecated">
  5187. <doc>
  5188. <![CDATA[@return Percentage of progress in maps]]>
  5189. </doc>
  5190. </method>
  5191. <method name="cleanupProgress" return="float"
  5192. abstract="false" native="false" synchronized="true"
  5193. static="false" final="false" visibility="public"
  5194. deprecated="not deprecated">
  5195. <doc>
  5196. <![CDATA[@return Percentage of progress in cleanup]]>
  5197. </doc>
  5198. </method>
  5199. <method name="setupProgress" return="float"
  5200. abstract="false" native="false" synchronized="true"
  5201. static="false" final="false" visibility="public"
  5202. deprecated="not deprecated">
  5203. <doc>
  5204. <![CDATA[@return Percentage of progress in setup]]>
  5205. </doc>
  5206. </method>
  5207. <method name="reduceProgress" return="float"
  5208. abstract="false" native="false" synchronized="true"
  5209. static="false" final="false" visibility="public"
  5210. deprecated="not deprecated">
  5211. <doc>
  5212. <![CDATA[@return Percentage of progress in reduce]]>
  5213. </doc>
  5214. </method>
  5215. <method name="getRunState" return="int"
  5216. abstract="false" native="false" synchronized="true"
  5217. static="false" final="false" visibility="public"
  5218. deprecated="not deprecated">
  5219. <doc>
  5220. <![CDATA[@return running state of the job]]>
  5221. </doc>
  5222. </method>
  5223. <method name="setRunState"
  5224. abstract="false" native="false" synchronized="true"
  5225. static="false" final="false" visibility="public"
  5226. deprecated="not deprecated">
  5227. <param name="state" type="int"/>
  5228. <doc>
  5229. <![CDATA[Change the current run state of the job.]]>
  5230. </doc>
  5231. </method>
  5232. <method name="getStartTime" return="long"
  5233. abstract="false" native="false" synchronized="true"
  5234. static="false" final="false" visibility="public"
  5235. deprecated="not deprecated">
  5236. <doc>
  5237. <![CDATA[@return start time of the job]]>
  5238. </doc>
  5239. </method>
  5240. <method name="clone" return="java.lang.Object"
  5241. abstract="false" native="false" synchronized="false"
  5242. static="false" final="false" visibility="public"
  5243. deprecated="not deprecated">
  5244. </method>
  5245. <method name="getUsername" return="java.lang.String"
  5246. abstract="false" native="false" synchronized="true"
  5247. static="false" final="false" visibility="public"
  5248. deprecated="not deprecated">
  5249. <doc>
  5250. <![CDATA[@return the username of the job]]>
  5251. </doc>
  5252. </method>
  5253. <method name="getSchedulingInfo" return="java.lang.String"
  5254. abstract="false" native="false" synchronized="true"
  5255. static="false" final="false" visibility="public"
  5256. deprecated="not deprecated">
  5257. <doc>
  5258. <![CDATA[Gets the Scheduling information associated to a particular Job.
  5259. @return the scheduling information of the job]]>
  5260. </doc>
  5261. </method>
  5262. <method name="setSchedulingInfo"
  5263. abstract="false" native="false" synchronized="true"
  5264. static="false" final="false" visibility="public"
  5265. deprecated="not deprecated">
  5266. <param name="schedulingInfo" type="java.lang.String"/>
  5267. <doc>
  5268. <![CDATA[Used to set the scheduling information associated to a particular Job.
  5269. @param schedulingInfo Scheduling information of the job]]>
  5270. </doc>
  5271. </method>
  5272. <method name="getJobPriority" return="org.apache.hadoop.mapred.JobPriority"
  5273. abstract="false" native="false" synchronized="true"
  5274. static="false" final="false" visibility="public"
  5275. deprecated="not deprecated">
  5276. <doc>
  5277. <![CDATA[Return the priority of the job
  5278. @return job priority]]>
  5279. </doc>
  5280. </method>
  5281. <method name="setJobPriority"
  5282. abstract="false" native="false" synchronized="true"
  5283. static="false" final="false" visibility="public"
  5284. deprecated="not deprecated">
  5285. <param name="jp" type="org.apache.hadoop.mapred.JobPriority"/>
  5286. <doc>
  5287. <![CDATA[Set the priority of the job, defaulting to NORMAL.
  5288. @param jp new job priority]]>
  5289. </doc>
  5290. </method>
  5291. <method name="isJobComplete" return="boolean"
  5292. abstract="false" native="false" synchronized="true"
  5293. static="false" final="false" visibility="public"
  5294. deprecated="not deprecated">
  5295. <doc>
  5296. <![CDATA[Returns true if the status is for a completed job.]]>
  5297. </doc>
  5298. </method>
  5299. <method name="write"
  5300. abstract="false" native="false" synchronized="true"
  5301. static="false" final="false" visibility="public"
  5302. deprecated="not deprecated">
  5303. <param name="out" type="java.io.DataOutput"/>
  5304. <exception name="IOException" type="java.io.IOException"/>
  5305. </method>
  5306. <method name="readFields"
  5307. abstract="false" native="false" synchronized="true"
  5308. static="false" final="false" visibility="public"
  5309. deprecated="not deprecated">
  5310. <param name="in" type="java.io.DataInput"/>
  5311. <exception name="IOException" type="java.io.IOException"/>
  5312. </method>
  5313. <field name="RUNNING" type="int"
  5314. transient="false" volatile="false"
  5315. static="true" final="true" visibility="public"
  5316. deprecated="not deprecated">
  5317. </field>
  5318. <field name="SUCCEEDED" type="int"
  5319. transient="false" volatile="false"
  5320. static="true" final="true" visibility="public"
  5321. deprecated="not deprecated">
  5322. </field>
  5323. <field name="FAILED" type="int"
  5324. transient="false" volatile="false"
  5325. static="true" final="true" visibility="public"
  5326. deprecated="not deprecated">
  5327. </field>
  5328. <field name="PREP" type="int"
  5329. transient="false" volatile="false"
  5330. static="true" final="true" visibility="public"
  5331. deprecated="not deprecated">
  5332. </field>
  5333. <field name="KILLED" type="int"
  5334. transient="false" volatile="false"
  5335. static="true" final="true" visibility="public"
  5336. deprecated="not deprecated">
  5337. </field>
  5338. <doc>
  5339. <![CDATA[Describes the current status of a job. This is
  5340. not intended to be a comprehensive piece of data.
  5341. For that, look at JobProfile.]]>
  5342. </doc>
  5343. </class>
  5344. <!-- end class org.apache.hadoop.mapred.JobStatus -->
  5345. <!-- start class org.apache.hadoop.mapred.JobTracker -->
  5346. <class name="JobTracker" extends="java.lang.Object"
  5347. abstract="false"
  5348. static="false" final="false" visibility="public"
  5349. deprecated="not deprecated">
  5350. <implements name="org.apache.hadoop.mapred.MRConstants"/>
  5351. <implements name="org.apache.hadoop.mapred.InterTrackerProtocol"/>
  5352. <implements name="org.apache.hadoop.mapred.JobSubmissionProtocol"/>
  5353. <implements name="org.apache.hadoop.mapred.TaskTrackerManager"/>
  5354. <implements name="org.apache.hadoop.security.authorize.RefreshAuthorizationPolicyProtocol"/>
  5355. <method name="startTracker" return="org.apache.hadoop.mapred.JobTracker"
  5356. abstract="false" native="false" synchronized="false"
  5357. static="true" final="false" visibility="public"
  5358. deprecated="not deprecated">
  5359. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  5360. <exception name="IOException" type="java.io.IOException"/>
  5361. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  5362. <doc>
  5363. <![CDATA[Start the JobTracker with given configuration.
  5364. The conf will be modified to reflect the actual ports on which
  5365. the JobTracker is up and running if the user passes the port as
  5366. <code>zero</code>.
  5367. @param conf configuration for the JobTracker.
  5368. @throws IOException]]>
  5369. </doc>
  5370. </method>
  5371. <method name="stopTracker"
  5372. abstract="false" native="false" synchronized="false"
  5373. static="false" final="false" visibility="public"
  5374. deprecated="not deprecated">
  5375. <exception name="IOException" type="java.io.IOException"/>
  5376. </method>
  5377. <method name="getProtocolVersion" return="long"
  5378. abstract="false" native="false" synchronized="false"
  5379. static="false" final="false" visibility="public"
  5380. deprecated="not deprecated">
  5381. <param name="protocol" type="java.lang.String"/>
  5382. <param name="clientVersion" type="long"/>
  5383. <exception name="IOException" type="java.io.IOException"/>
  5384. </method>
  5385. <method name="hasRestarted" return="boolean"
  5386. abstract="false" native="false" synchronized="false"
  5387. static="false" final="false" visibility="public"
  5388. deprecated="not deprecated">
  5389. <doc>
  5390. <![CDATA[Whether the JT has restarted]]>
  5391. </doc>
  5392. </method>
  5393. <method name="hasRecovered" return="boolean"
  5394. abstract="false" native="false" synchronized="false"
  5395. static="false" final="false" visibility="public"
  5396. deprecated="not deprecated">
  5397. <doc>
  5398. <![CDATA[Whether the JT has recovered upon restart]]>
  5399. </doc>
  5400. </method>
  5401. <method name="getRecoveryDuration" return="long"
  5402. abstract="false" native="false" synchronized="false"
  5403. static="false" final="false" visibility="public"
  5404. deprecated="not deprecated">
  5405. <doc>
  5406. <![CDATA[How long the jobtracker took to recover from restart.]]>
  5407. </doc>
  5408. </method>
  5409. <method name="getInstrumentationClass" return="java.lang.Class"
  5410. abstract="false" native="false" synchronized="false"
  5411. static="true" final="false" visibility="public"
  5412. deprecated="not deprecated">
  5413. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  5414. </method>
  5415. <method name="setInstrumentationClass"
  5416. abstract="false" native="false" synchronized="false"
  5417. static="true" final="false" visibility="public"
  5418. deprecated="not deprecated">
  5419. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  5420. <param name="t" type="java.lang.Class"/>
  5421. </method>
  5422. <method name="getAddress" return="java.net.InetSocketAddress"
  5423. abstract="false" native="false" synchronized="false"
  5424. static="true" final="false" visibility="public"
  5425. deprecated="not deprecated">
  5426. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  5427. </method>
  5428. <method name="offerService"
  5429. abstract="false" native="false" synchronized="false"
  5430. static="false" final="false" visibility="public"
  5431. deprecated="not deprecated">
  5432. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  5433. <exception name="IOException" type="java.io.IOException"/>
  5434. <doc>
  5435. <![CDATA[Run forever]]>
  5436. </doc>
  5437. </method>
  5438. <method name="getTotalSubmissions" return="int"
  5439. abstract="false" native="false" synchronized="false"
  5440. static="false" final="false" visibility="public"
  5441. deprecated="not deprecated">
  5442. </method>
  5443. <method name="getJobTrackerMachine" return="java.lang.String"
  5444. abstract="false" native="false" synchronized="false"
  5445. static="false" final="false" visibility="public"
  5446. deprecated="not deprecated">
  5447. </method>
  5448. <method name="getTrackerIdentifier" return="java.lang.String"
  5449. abstract="false" native="false" synchronized="false"
  5450. static="false" final="false" visibility="public"
  5451. deprecated="not deprecated">
  5452. <doc>
  5453. <![CDATA[Get the unique identifier (ie. timestamp) of this job tracker start.
  5454. @return a string with a unique identifier]]>
  5455. </doc>
  5456. </method>
  5457. <method name="getTrackerPort" return="int"
  5458. abstract="false" native="false" synchronized="false"
  5459. static="false" final="false" visibility="public"
  5460. deprecated="not deprecated">
  5461. </method>
  5462. <method name="getInfoPort" return="int"
  5463. abstract="false" native="false" synchronized="false"
  5464. static="false" final="false" visibility="public"
  5465. deprecated="not deprecated">
  5466. </method>
  5467. <method name="getStartTime" return="long"
  5468. abstract="false" native="false" synchronized="false"
  5469. static="false" final="false" visibility="public"
  5470. deprecated="not deprecated">
  5471. </method>
  5472. <method name="runningJobs" return="java.util.Vector"
  5473. abstract="false" native="false" synchronized="false"
  5474. static="false" final="false" visibility="public"
  5475. deprecated="not deprecated">
  5476. </method>
  5477. <method name="getRunningJobs" return="java.util.List"
  5478. abstract="false" native="false" synchronized="true"
  5479. static="false" final="false" visibility="public"
  5480. deprecated="not deprecated">
  5481. <doc>
  5482. <![CDATA[Version that is called from a timer thread, and therefore needs to be
  5483. careful to synchronize.]]>
  5484. </doc>
  5485. </method>
  5486. <method name="failedJobs" return="java.util.Vector"
  5487. abstract="false" native="false" synchronized="false"
  5488. static="false" final="false" visibility="public"
  5489. deprecated="not deprecated">
  5490. </method>
  5491. <method name="completedJobs" return="java.util.Vector"
  5492. abstract="false" native="false" synchronized="false"
  5493. static="false" final="false" visibility="public"
  5494. deprecated="not deprecated">
  5495. </method>
  5496. <method name="taskTrackers" return="java.util.Collection"
  5497. abstract="false" native="false" synchronized="false"
  5498. static="false" final="false" visibility="public"
  5499. deprecated="not deprecated">
  5500. <doc>
  5501. <![CDATA[Get all the task trackers in the cluster
  5502. @return {@link Collection} of {@link TaskTrackerStatus}]]>
  5503. </doc>
  5504. </method>
  5505. <method name="activeTaskTrackers" return="java.util.Collection"
  5506. abstract="false" native="false" synchronized="false"
  5507. static="false" final="false" visibility="public"
  5508. deprecated="not deprecated">
  5509. <doc>
  5510. <![CDATA[Get the active task tracker statuses in the cluster
  5511. @return {@link Collection} of active {@link TaskTrackerStatus}]]>
  5512. </doc>
  5513. </method>
  5514. <method name="taskTrackerNames" return="java.util.List"
  5515. abstract="false" native="false" synchronized="false"
  5516. static="false" final="false" visibility="public"
  5517. deprecated="not deprecated">
  5518. <doc>
  5519. <![CDATA[Get the active and blacklisted task tracker names in the cluster. The first
  5520. element in the returned list contains the list of active tracker names.
  5521. The second element in the returned list contains the list of blacklisted
  5522. tracker names.]]>
  5523. </doc>
  5524. </method>
  5525. <method name="blacklistedTaskTrackers" return="java.util.Collection"
  5526. abstract="false" native="false" synchronized="false"
  5527. static="false" final="false" visibility="public"
  5528. deprecated="not deprecated">
  5529. <doc>
  5530. <![CDATA[Get the blacklisted task tracker statuses in the cluster
  5531. @return {@link Collection} of blacklisted {@link TaskTrackerStatus}]]>
  5532. </doc>
  5533. </method>
  5534. <method name="isBlacklisted" return="boolean"
  5535. abstract="false" native="false" synchronized="false"
  5536. static="false" final="false" visibility="public"
  5537. deprecated="not deprecated">
  5538. <param name="trackerID" type="java.lang.String"/>
  5539. <doc>
  5540. <![CDATA[Whether the tracker is blacklisted or not
  5541. @param trackerID
  5542. @return true if blacklisted, false otherwise]]>
  5543. </doc>
  5544. </method>
  5545. <method name="getTaskTracker" return="org.apache.hadoop.mapred.TaskTrackerStatus"
  5546. abstract="false" native="false" synchronized="false"
  5547. static="false" final="false" visibility="public"
  5548. deprecated="not deprecated">
  5549. <param name="trackerID" type="java.lang.String"/>
  5550. </method>
  5551. <method name="resolveAndAddToTopology" return="org.apache.hadoop.net.Node"
  5552. abstract="false" native="false" synchronized="false"
  5553. static="false" final="false" visibility="public"
  5554. deprecated="not deprecated">
  5555. <param name="name" type="java.lang.String"/>
  5556. </method>
  5557. <method name="getNodesAtMaxLevel" return="java.util.Collection"
  5558. abstract="false" native="false" synchronized="false"
  5559. static="false" final="false" visibility="public"
  5560. deprecated="not deprecated">
  5561. <doc>
  5562. <![CDATA[Returns a collection of nodes at the max level]]>
  5563. </doc>
  5564. </method>
  5565. <method name="getParentNode" return="org.apache.hadoop.net.Node"
  5566. abstract="false" native="false" synchronized="false"
  5567. static="true" final="false" visibility="public"
  5568. deprecated="not deprecated">
  5569. <param name="node" type="org.apache.hadoop.net.Node"/>
  5570. <param name="level" type="int"/>
  5571. </method>
  5572. <method name="getNode" return="org.apache.hadoop.net.Node"
  5573. abstract="false" native="false" synchronized="false"
  5574. static="false" final="false" visibility="public"
  5575. deprecated="not deprecated">
  5576. <param name="name" type="java.lang.String"/>
  5577. <doc>
  5578. <![CDATA[Return the Node in the network topology that corresponds to the hostname]]>
  5579. </doc>
  5580. </method>
  5581. <method name="getNumTaskCacheLevels" return="int"
  5582. abstract="false" native="false" synchronized="false"
  5583. static="false" final="false" visibility="public"
  5584. deprecated="not deprecated">
  5585. </method>
  5586. <method name="getNumResolvedTaskTrackers" return="int"
  5587. abstract="false" native="false" synchronized="false"
  5588. static="false" final="false" visibility="public"
  5589. deprecated="not deprecated">
  5590. </method>
  5591. <method name="getNumberOfUniqueHosts" return="int"
  5592. abstract="false" native="false" synchronized="false"
  5593. static="false" final="false" visibility="public"
  5594. deprecated="not deprecated">
  5595. </method>
  5596. <method name="addJobInProgressListener"
  5597. abstract="false" native="false" synchronized="false"
  5598. static="false" final="false" visibility="public"
  5599. deprecated="not deprecated">
  5600. <param name="listener" type="org.apache.hadoop.mapred.JobInProgressListener"/>
  5601. </method>
  5602. <method name="removeJobInProgressListener"
  5603. abstract="false" native="false" synchronized="false"
  5604. static="false" final="false" visibility="public"
  5605. deprecated="not deprecated">
  5606. <param name="listener" type="org.apache.hadoop.mapred.JobInProgressListener"/>
  5607. </method>
  5608. <method name="getQueueManager" return="org.apache.hadoop.mapred.QueueManager"
  5609. abstract="false" native="false" synchronized="false"
  5610. static="false" final="false" visibility="public"
  5611. deprecated="not deprecated">
  5612. <doc>
  5613. <![CDATA[Return the {@link QueueManager} associated with the JobTracker.]]>
  5614. </doc>
  5615. </method>
  5616. <method name="getBuildVersion" return="java.lang.String"
  5617. abstract="false" native="false" synchronized="false"
  5618. static="false" final="false" visibility="public"
  5619. deprecated="not deprecated">
  5620. <exception name="IOException" type="java.io.IOException"/>
  5621. </method>
  5622. <method name="heartbeat" return="org.apache.hadoop.mapred.HeartbeatResponse"
  5623. abstract="false" native="false" synchronized="true"
  5624. static="false" final="false" visibility="public"
  5625. deprecated="not deprecated">
  5626. <param name="status" type="org.apache.hadoop.mapred.TaskTrackerStatus"/>
  5627. <param name="restarted" type="boolean"/>
  5628. <param name="initialContact" type="boolean"/>
  5629. <param name="acceptNewTasks" type="boolean"/>
  5630. <param name="responseId" type="short"/>
  5631. <exception name="IOException" type="java.io.IOException"/>
  5632. <doc>
  5633. <![CDATA[The periodic heartbeat mechanism between the {@link TaskTracker} and
  5634. the {@link JobTracker}.
  5635. The {@link JobTracker} processes the status information sent by the
  5636. {@link TaskTracker} and responds with instructions to start/stop
  5637. tasks or jobs, and also 'reset' instructions during contingencies.]]>
  5638. </doc>
  5639. </method>
  5640. <method name="getNextHeartbeatInterval" return="int"
  5641. abstract="false" native="false" synchronized="false"
  5642. static="false" final="false" visibility="public"
  5643. deprecated="not deprecated">
  5644. <doc>
  5645. <![CDATA[Calculates next heartbeat interval using cluster size.
  5646. Heartbeat interval is incremented 1second for every 50 nodes.
  5647. @return next heartbeat interval.]]>
  5648. </doc>
  5649. </method>
  5650. <method name="getFilesystemName" return="java.lang.String"
  5651. abstract="false" native="false" synchronized="true"
  5652. static="false" final="false" visibility="public"
  5653. deprecated="not deprecated">
  5654. <exception name="IOException" type="java.io.IOException"/>
  5655. <doc>
  5656. <![CDATA[Grab the local fs name]]>
  5657. </doc>
  5658. </method>
  5659. <method name="reportTaskTrackerError"
  5660. abstract="false" native="false" synchronized="false"
  5661. static="false" final="false" visibility="public"
  5662. deprecated="not deprecated">
  5663. <param name="taskTracker" type="java.lang.String"/>
  5664. <param name="errorClass" type="java.lang.String"/>
  5665. <param name="errorMessage" type="java.lang.String"/>
  5666. <exception name="IOException" type="java.io.IOException"/>
  5667. </method>
  5668. <method name="getNewJobId" return="org.apache.hadoop.mapred.JobID"
  5669. abstract="false" native="false" synchronized="true"
  5670. static="false" final="false" visibility="public"
  5671. deprecated="not deprecated">
  5672. <exception name="IOException" type="java.io.IOException"/>
  5673. <doc>
  5674. <![CDATA[Allocates a new JobId string.]]>
  5675. </doc>
  5676. </method>
  5677. <method name="submitJob" return="org.apache.hadoop.mapred.JobStatus"
  5678. abstract="false" native="false" synchronized="true"
  5679. static="false" final="false" visibility="public"
  5680. deprecated="not deprecated">
  5681. <param name="jobId" type="org.apache.hadoop.mapred.JobID"/>
  5682. <exception name="IOException" type="java.io.IOException"/>
  5683. <doc>
  5684. <![CDATA[JobTracker.submitJob() kicks off a new job.
  5685. Create a 'JobInProgress' object, which contains both JobProfile
  5686. and JobStatus. Those two sub-objects are sometimes shipped outside
  5687. of the JobTracker. But JobInProgress adds info that's useful for
  5688. the JobTracker alone.]]>
  5689. </doc>
  5690. </method>
  5691. <method name="getClusterStatus" return="org.apache.hadoop.mapred.ClusterStatus"
  5692. abstract="false" native="false" synchronized="true"
  5693. static="false" final="false" visibility="public"
  5694. deprecated="use {@link #getClusterStatus(boolean)}">
  5695. <doc>
  5696. <![CDATA[@deprecated use {@link #getClusterStatus(boolean)}]]>
  5697. </doc>
  5698. </method>
  5699. <method name="getClusterStatus" return="org.apache.hadoop.mapred.ClusterStatus"
  5700. abstract="false" native="false" synchronized="true"
  5701. static="false" final="false" visibility="public"
  5702. deprecated="not deprecated">
  5703. <param name="detailed" type="boolean"/>
  5704. </method>
  5705. <method name="killJob"
  5706. abstract="false" native="false" synchronized="true"
  5707. static="false" final="false" visibility="public"
  5708. deprecated="not deprecated">
  5709. <param name="jobid" type="org.apache.hadoop.mapred.JobID"/>
  5710. <exception name="IOException" type="java.io.IOException"/>
  5711. </method>
  5712. <method name="setJobPriority"
  5713. abstract="false" native="false" synchronized="true"
  5714. static="false" final="false" visibility="public"
  5715. deprecated="not deprecated">
  5716. <param name="jobid" type="org.apache.hadoop.mapred.JobID"/>
  5717. <param name="priority" type="java.lang.String"/>
  5718. <exception name="IOException" type="java.io.IOException"/>
  5719. <doc>
  5720. <![CDATA[Set the priority of a job
  5721. @param jobid id of the job
  5722. @param priority new priority of the job]]>
  5723. </doc>
  5724. </method>
  5725. <method name="getJobProfile" return="org.apache.hadoop.mapred.JobProfile"
  5726. abstract="false" native="false" synchronized="false"
  5727. static="false" final="false" visibility="public"
  5728. deprecated="not deprecated">
  5729. <param name="jobid" type="org.apache.hadoop.mapred.JobID"/>
  5730. </method>
  5731. <method name="getJobStatus" return="org.apache.hadoop.mapred.JobStatus"
  5732. abstract="false" native="false" synchronized="false"
  5733. static="false" final="false" visibility="public"
  5734. deprecated="not deprecated">
  5735. <param name="jobid" type="org.apache.hadoop.mapred.JobID"/>
  5736. </method>
  5737. <method name="getJobCounters" return="org.apache.hadoop.mapred.Counters"
  5738. abstract="false" native="false" synchronized="false"
  5739. static="false" final="false" visibility="public"
  5740. deprecated="not deprecated">
  5741. <param name="jobid" type="org.apache.hadoop.mapred.JobID"/>
  5742. </method>
  5743. <method name="getMapTaskReports" return="org.apache.hadoop.mapred.TaskReport[]"
  5744. abstract="false" native="false" synchronized="true"
  5745. static="false" final="false" visibility="public"
  5746. deprecated="not deprecated">
  5747. <param name="jobid" type="org.apache.hadoop.mapred.JobID"/>
  5748. </method>
  5749. <method name="getReduceTaskReports" return="org.apache.hadoop.mapred.TaskReport[]"
  5750. abstract="false" native="false" synchronized="true"
  5751. static="false" final="false" visibility="public"
  5752. deprecated="not deprecated">
  5753. <param name="jobid" type="org.apache.hadoop.mapred.JobID"/>
  5754. </method>
  5755. <method name="getCleanupTaskReports" return="org.apache.hadoop.mapred.TaskReport[]"
  5756. abstract="false" native="false" synchronized="true"
  5757. static="false" final="false" visibility="public"
  5758. deprecated="not deprecated">
  5759. <param name="jobid" type="org.apache.hadoop.mapred.JobID"/>
  5760. </method>
  5761. <method name="getSetupTaskReports" return="org.apache.hadoop.mapred.TaskReport[]"
  5762. abstract="false" native="false" synchronized="true"
  5763. static="false" final="false" visibility="public"
  5764. deprecated="not deprecated">
  5765. <param name="jobid" type="org.apache.hadoop.mapred.JobID"/>
  5766. </method>
  5767. <method name="getTaskCompletionEvents" return="org.apache.hadoop.mapred.TaskCompletionEvent[]"
  5768. abstract="false" native="false" synchronized="true"
  5769. static="false" final="false" visibility="public"
  5770. deprecated="not deprecated">
  5771. <param name="jobid" type="org.apache.hadoop.mapred.JobID"/>
  5772. <param name="fromEventId" type="int"/>
  5773. <param name="maxEvents" type="int"/>
  5774. <exception name="IOException" type="java.io.IOException"/>
  5775. </method>
  5776. <method name="getTaskDiagnostics" return="java.lang.String[]"
  5777. abstract="false" native="false" synchronized="true"
  5778. static="false" final="false" visibility="public"
  5779. deprecated="not deprecated">
  5780. <param name="taskId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  5781. <exception name="IOException" type="java.io.IOException"/>
  5782. <doc>
  5783. <![CDATA[Get the diagnostics for a given task
  5784. @param taskId the id of the task
  5785. @return an array of the diagnostic messages]]>
  5786. </doc>
  5787. </method>
  5788. <method name="getTip" return="org.apache.hadoop.mapred.TaskInProgress"
  5789. abstract="false" native="false" synchronized="false"
  5790. static="false" final="false" visibility="public"
  5791. deprecated="not deprecated">
  5792. <param name="tipid" type="org.apache.hadoop.mapred.TaskID"/>
  5793. <doc>
  5794. <![CDATA[Returns specified TaskInProgress, or null.]]>
  5795. </doc>
  5796. </method>
  5797. <method name="killTask" return="boolean"
  5798. abstract="false" native="false" synchronized="true"
  5799. static="false" final="false" visibility="public"
  5800. deprecated="not deprecated">
  5801. <param name="taskid" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  5802. <param name="shouldFail" type="boolean"/>
  5803. <exception name="IOException" type="java.io.IOException"/>
  5804. <doc>
  5805. <![CDATA[Mark a Task to be killed]]>
  5806. </doc>
  5807. </method>
  5808. <method name="getAssignedTracker" return="java.lang.String"
  5809. abstract="false" native="false" synchronized="true"
  5810. static="false" final="false" visibility="public"
  5811. deprecated="not deprecated">
  5812. <param name="taskId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  5813. <doc>
  5814. <![CDATA[Get tracker name for a given task id.
  5815. @param taskId the name of the task
  5816. @return The name of the task tracker]]>
  5817. </doc>
  5818. </method>
  5819. <method name="jobsToComplete" return="org.apache.hadoop.mapred.JobStatus[]"
  5820. abstract="false" native="false" synchronized="false"
  5821. static="false" final="false" visibility="public"
  5822. deprecated="not deprecated">
  5823. </method>
  5824. <method name="getAllJobs" return="org.apache.hadoop.mapred.JobStatus[]"
  5825. abstract="false" native="false" synchronized="false"
  5826. static="false" final="false" visibility="public"
  5827. deprecated="not deprecated">
  5828. </method>
  5829. <method name="getSystemDir" return="java.lang.String"
  5830. abstract="false" native="false" synchronized="false"
  5831. static="false" final="false" visibility="public"
  5832. deprecated="not deprecated">
  5833. <doc>
  5834. <![CDATA[@see org.apache.hadoop.mapred.JobSubmissionProtocol#getSystemDir()]]>
  5835. </doc>
  5836. </method>
  5837. <method name="getJob" return="org.apache.hadoop.mapred.JobInProgress"
  5838. abstract="false" native="false" synchronized="false"
  5839. static="false" final="false" visibility="public"
  5840. deprecated="not deprecated">
  5841. <param name="jobid" type="org.apache.hadoop.mapred.JobID"/>
  5842. </method>
  5843. <method name="getLocalJobFilePath" return="java.lang.String"
  5844. abstract="false" native="false" synchronized="false"
  5845. static="true" final="false" visibility="public"
  5846. deprecated="not deprecated">
  5847. <param name="jobId" type="org.apache.hadoop.mapred.JobID"/>
  5848. <doc>
  5849. <![CDATA[Get the localized job file path on the job trackers local file system
  5850. @param jobId id of the job
  5851. @return the path of the job conf file on the local file system]]>
  5852. </doc>
  5853. </method>
  5854. <method name="main"
  5855. abstract="false" native="false" synchronized="false"
  5856. static="true" final="false" visibility="public"
  5857. deprecated="not deprecated">
  5858. <param name="argv" type="java.lang.String[]"/>
  5859. <exception name="IOException" type="java.io.IOException"/>
  5860. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  5861. <doc>
  5862. <![CDATA[Start the JobTracker process. This is used only for debugging. As a rule,
  5863. JobTracker should be run as part of the DFS Namenode process.]]>
  5864. </doc>
  5865. </method>
  5866. <method name="getQueues" return="org.apache.hadoop.mapred.JobQueueInfo[]"
  5867. abstract="false" native="false" synchronized="false"
  5868. static="false" final="false" visibility="public"
  5869. deprecated="not deprecated">
  5870. <exception name="IOException" type="java.io.IOException"/>
  5871. </method>
  5872. <method name="getQueueInfo" return="org.apache.hadoop.mapred.JobQueueInfo"
  5873. abstract="false" native="false" synchronized="false"
  5874. static="false" final="false" visibility="public"
  5875. deprecated="not deprecated">
  5876. <param name="queue" type="java.lang.String"/>
  5877. <exception name="IOException" type="java.io.IOException"/>
  5878. </method>
  5879. <method name="getJobsFromQueue" return="org.apache.hadoop.mapred.JobStatus[]"
  5880. abstract="false" native="false" synchronized="false"
  5881. static="false" final="false" visibility="public"
  5882. deprecated="not deprecated">
  5883. <param name="queue" type="java.lang.String"/>
  5884. <exception name="IOException" type="java.io.IOException"/>
  5885. </method>
  5886. <method name="refreshServiceAcl"
  5887. abstract="false" native="false" synchronized="false"
  5888. static="false" final="false" visibility="public"
  5889. deprecated="not deprecated">
  5890. <exception name="IOException" type="java.io.IOException"/>
  5891. </method>
  5892. <field name="LOG" type="org.apache.commons.logging.Log"
  5893. transient="false" volatile="false"
  5894. static="true" final="true" visibility="public"
  5895. deprecated="not deprecated">
  5896. </field>
  5897. <doc>
  5898. <![CDATA[JobTracker is the central location for submitting and
  5899. tracking MR jobs in a network environment.]]>
  5900. </doc>
  5901. </class>
  5902. <!-- end class org.apache.hadoop.mapred.JobTracker -->
  5903. <!-- start class org.apache.hadoop.mapred.JobTracker.IllegalStateException -->
  5904. <class name="JobTracker.IllegalStateException" extends="java.io.IOException"
  5905. abstract="false"
  5906. static="true" final="false" visibility="public"
  5907. deprecated="not deprecated">
  5908. <constructor name="JobTracker.IllegalStateException" type="java.lang.String"
  5909. static="false" final="false" visibility="public"
  5910. deprecated="not deprecated">
  5911. </constructor>
  5912. <doc>
  5913. <![CDATA[A client tried to submit a job before the Job Tracker was ready.]]>
  5914. </doc>
  5915. </class>
  5916. <!-- end class org.apache.hadoop.mapred.JobTracker.IllegalStateException -->
  5917. <!-- start class org.apache.hadoop.mapred.JobTracker.State -->
  5918. <class name="JobTracker.State" extends="java.lang.Enum"
  5919. abstract="false"
  5920. static="true" final="true" visibility="public"
  5921. deprecated="not deprecated">
  5922. <method name="values" return="org.apache.hadoop.mapred.JobTracker.State[]"
  5923. abstract="false" native="false" synchronized="false"
  5924. static="true" final="false" visibility="public"
  5925. deprecated="not deprecated">
  5926. </method>
  5927. <method name="valueOf" return="org.apache.hadoop.mapred.JobTracker.State"
  5928. abstract="false" native="false" synchronized="false"
  5929. static="true" final="false" visibility="public"
  5930. deprecated="not deprecated">
  5931. <param name="name" type="java.lang.String"/>
  5932. </method>
  5933. <field name="INITIALIZING" type="org.apache.hadoop.mapred.JobTracker.State"
  5934. transient="false" volatile="false"
  5935. static="true" final="true" visibility="public"
  5936. deprecated="not deprecated">
  5937. </field>
  5938. <field name="RUNNING" type="org.apache.hadoop.mapred.JobTracker.State"
  5939. transient="false" volatile="false"
  5940. static="true" final="true" visibility="public"
  5941. deprecated="not deprecated">
  5942. </field>
  5943. </class>
  5944. <!-- end class org.apache.hadoop.mapred.JobTracker.State -->
  5945. <!-- start class org.apache.hadoop.mapred.KeyValueLineRecordReader -->
  5946. <class name="KeyValueLineRecordReader" extends="java.lang.Object"
  5947. abstract="false"
  5948. static="false" final="false" visibility="public"
  5949. deprecated="not deprecated">
  5950. <implements name="org.apache.hadoop.mapred.RecordReader"/>
  5951. <constructor name="KeyValueLineRecordReader" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.mapred.FileSplit"
  5952. static="false" final="false" visibility="public"
  5953. deprecated="not deprecated">
  5954. <exception name="IOException" type="java.io.IOException"/>
  5955. </constructor>
  5956. <method name="getKeyClass" return="java.lang.Class"
  5957. abstract="false" native="false" synchronized="false"
  5958. static="false" final="false" visibility="public"
  5959. deprecated="not deprecated">
  5960. </method>
  5961. <method name="createKey" return="org.apache.hadoop.io.Text"
  5962. abstract="false" native="false" synchronized="false"
  5963. static="false" final="false" visibility="public"
  5964. deprecated="not deprecated">
  5965. </method>
  5966. <method name="createValue" return="org.apache.hadoop.io.Text"
  5967. abstract="false" native="false" synchronized="false"
  5968. static="false" final="false" visibility="public"
  5969. deprecated="not deprecated">
  5970. </method>
  5971. <method name="findSeparator" return="int"
  5972. abstract="false" native="false" synchronized="false"
  5973. static="true" final="false" visibility="public"
  5974. deprecated="not deprecated">
  5975. <param name="utf" type="byte[]"/>
  5976. <param name="start" type="int"/>
  5977. <param name="length" type="int"/>
  5978. <param name="sep" type="byte"/>
  5979. </method>
  5980. <method name="next" return="boolean"
  5981. abstract="false" native="false" synchronized="true"
  5982. static="false" final="false" visibility="public"
  5983. deprecated="not deprecated">
  5984. <param name="key" type="org.apache.hadoop.io.Text"/>
  5985. <param name="value" type="org.apache.hadoop.io.Text"/>
  5986. <exception name="IOException" type="java.io.IOException"/>
  5987. <doc>
  5988. <![CDATA[Read key/value pair in a line.]]>
  5989. </doc>
  5990. </method>
  5991. <method name="getProgress" return="float"
  5992. abstract="false" native="false" synchronized="false"
  5993. static="false" final="false" visibility="public"
  5994. deprecated="not deprecated">
  5995. </method>
  5996. <method name="getPos" return="long"
  5997. abstract="false" native="false" synchronized="true"
  5998. static="false" final="false" visibility="public"
  5999. deprecated="not deprecated">
  6000. <exception name="IOException" type="java.io.IOException"/>
  6001. </method>
  6002. <method name="close"
  6003. abstract="false" native="false" synchronized="true"
  6004. static="false" final="false" visibility="public"
  6005. deprecated="not deprecated">
  6006. <exception name="IOException" type="java.io.IOException"/>
  6007. </method>
  6008. <doc>
  6009. <![CDATA[This class treats a line in the input as a key/value pair separated by a
  6010. separator character. The separator can be specified in config file
  6011. under the attribute name key.value.separator.in.input.line. The default
  6012. separator is the tab character ('\t').]]>
  6013. </doc>
  6014. </class>
  6015. <!-- end class org.apache.hadoop.mapred.KeyValueLineRecordReader -->
  6016. <!-- start class org.apache.hadoop.mapred.KeyValueTextInputFormat -->
  6017. <class name="KeyValueTextInputFormat" extends="org.apache.hadoop.mapred.FileInputFormat"
  6018. abstract="false"
  6019. static="false" final="false" visibility="public"
  6020. deprecated="not deprecated">
  6021. <implements name="org.apache.hadoop.mapred.JobConfigurable"/>
  6022. <constructor name="KeyValueTextInputFormat"
  6023. static="false" final="false" visibility="public"
  6024. deprecated="not deprecated">
  6025. </constructor>
  6026. <method name="configure"
  6027. abstract="false" native="false" synchronized="false"
  6028. static="false" final="false" visibility="public"
  6029. deprecated="not deprecated">
  6030. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  6031. </method>
  6032. <method name="isSplitable" return="boolean"
  6033. abstract="false" native="false" synchronized="false"
  6034. static="false" final="false" visibility="protected"
  6035. deprecated="not deprecated">
  6036. <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
  6037. <param name="file" type="org.apache.hadoop.fs.Path"/>
  6038. </method>
  6039. <method name="getRecordReader" return="org.apache.hadoop.mapred.RecordReader"
  6040. abstract="false" native="false" synchronized="false"
  6041. static="false" final="false" visibility="public"
  6042. deprecated="not deprecated">
  6043. <param name="genericSplit" type="org.apache.hadoop.mapred.InputSplit"/>
  6044. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  6045. <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
  6046. <exception name="IOException" type="java.io.IOException"/>
  6047. </method>
  6048. <doc>
  6049. <![CDATA[An {@link InputFormat} for plain text files. Files are broken into lines.
  6050. Either linefeed or carriage-return are used to signal end of line. Each line
  6051. is divided into key and value parts by a separator byte. If no such a byte
  6052. exists, the key will be the entire line and value will be empty.]]>
  6053. </doc>
  6054. </class>
  6055. <!-- end class org.apache.hadoop.mapred.KeyValueTextInputFormat -->
  6056. <!-- start class org.apache.hadoop.mapred.LineRecordReader -->
  6057. <class name="LineRecordReader" extends="java.lang.Object"
  6058. abstract="false"
  6059. static="false" final="false" visibility="public"
  6060. deprecated="Use
  6061. {@link org.apache.hadoop.mapreduce.lib.input.LineRecordReader} instead.">
  6062. <implements name="org.apache.hadoop.mapred.RecordReader"/>
  6063. <constructor name="LineRecordReader" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.mapred.FileSplit"
  6064. static="false" final="false" visibility="public"
  6065. deprecated="not deprecated">
  6066. <exception name="IOException" type="java.io.IOException"/>
  6067. </constructor>
  6068. <constructor name="LineRecordReader" type="java.io.InputStream, long, long, int"
  6069. static="false" final="false" visibility="public"
  6070. deprecated="not deprecated">
  6071. </constructor>
  6072. <constructor name="LineRecordReader" type="java.io.InputStream, long, long, org.apache.hadoop.conf.Configuration"
  6073. static="false" final="false" visibility="public"
  6074. deprecated="not deprecated">
  6075. <exception name="IOException" type="java.io.IOException"/>
  6076. </constructor>
  6077. <method name="createKey" return="org.apache.hadoop.io.LongWritable"
  6078. abstract="false" native="false" synchronized="false"
  6079. static="false" final="false" visibility="public"
  6080. deprecated="not deprecated">
  6081. </method>
  6082. <method name="createValue" return="org.apache.hadoop.io.Text"
  6083. abstract="false" native="false" synchronized="false"
  6084. static="false" final="false" visibility="public"
  6085. deprecated="not deprecated">
  6086. </method>
  6087. <method name="next" return="boolean"
  6088. abstract="false" native="false" synchronized="true"
  6089. static="false" final="false" visibility="public"
  6090. deprecated="not deprecated">
  6091. <param name="key" type="org.apache.hadoop.io.LongWritable"/>
  6092. <param name="value" type="org.apache.hadoop.io.Text"/>
  6093. <exception name="IOException" type="java.io.IOException"/>
  6094. <doc>
  6095. <![CDATA[Read a line.]]>
  6096. </doc>
  6097. </method>
  6098. <method name="getProgress" return="float"
  6099. abstract="false" native="false" synchronized="false"
  6100. static="false" final="false" visibility="public"
  6101. deprecated="not deprecated">
  6102. <doc>
  6103. <![CDATA[Get the progress within the split]]>
  6104. </doc>
  6105. </method>
  6106. <method name="getPos" return="long"
  6107. abstract="false" native="false" synchronized="true"
  6108. static="false" final="false" visibility="public"
  6109. deprecated="not deprecated">
  6110. <exception name="IOException" type="java.io.IOException"/>
  6111. </method>
  6112. <method name="close"
  6113. abstract="false" native="false" synchronized="true"
  6114. static="false" final="false" visibility="public"
  6115. deprecated="not deprecated">
  6116. <exception name="IOException" type="java.io.IOException"/>
  6117. </method>
  6118. <doc>
  6119. <![CDATA[Treats keys as offset in file and value as line.
  6120. @deprecated Use
  6121. {@link org.apache.hadoop.mapreduce.lib.input.LineRecordReader} instead.]]>
  6122. </doc>
  6123. </class>
  6124. <!-- end class org.apache.hadoop.mapred.LineRecordReader -->
  6125. <!-- start class org.apache.hadoop.mapred.LineRecordReader.LineReader -->
  6126. <class name="LineRecordReader.LineReader" extends="org.apache.hadoop.util.LineReader"
  6127. abstract="false"
  6128. static="true" final="false" visibility="public"
  6129. deprecated="Use {@link org.apache.hadoop.util.LineReader} instead.">
  6130. <constructor name="LineRecordReader.LineReader" type="java.io.InputStream, org.apache.hadoop.conf.Configuration"
  6131. static="false" final="false" visibility="public"
  6132. deprecated="not deprecated">
  6133. <exception name="IOException" type="java.io.IOException"/>
  6134. </constructor>
  6135. <doc>
  6136. <![CDATA[A class that provides a line reader from an input stream.
  6137. @deprecated Use {@link org.apache.hadoop.util.LineReader} instead.]]>
  6138. </doc>
  6139. </class>
  6140. <!-- end class org.apache.hadoop.mapred.LineRecordReader.LineReader -->
  6141. <!-- start class org.apache.hadoop.mapred.MapFileOutputFormat -->
  6142. <class name="MapFileOutputFormat" extends="org.apache.hadoop.mapred.FileOutputFormat"
  6143. abstract="false"
  6144. static="false" final="false" visibility="public"
  6145. deprecated="not deprecated">
  6146. <constructor name="MapFileOutputFormat"
  6147. static="false" final="false" visibility="public"
  6148. deprecated="not deprecated">
  6149. </constructor>
  6150. <method name="getRecordWriter" return="org.apache.hadoop.mapred.RecordWriter"
  6151. abstract="false" native="false" synchronized="false"
  6152. static="false" final="false" visibility="public"
  6153. deprecated="not deprecated">
  6154. <param name="ignored" type="org.apache.hadoop.fs.FileSystem"/>
  6155. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  6156. <param name="name" type="java.lang.String"/>
  6157. <param name="progress" type="org.apache.hadoop.util.Progressable"/>
  6158. <exception name="IOException" type="java.io.IOException"/>
  6159. </method>
  6160. <method name="getReaders" return="org.apache.hadoop.io.MapFile.Reader[]"
  6161. abstract="false" native="false" synchronized="false"
  6162. static="true" final="false" visibility="public"
  6163. deprecated="not deprecated">
  6164. <param name="ignored" type="org.apache.hadoop.fs.FileSystem"/>
  6165. <param name="dir" type="org.apache.hadoop.fs.Path"/>
  6166. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  6167. <exception name="IOException" type="java.io.IOException"/>
  6168. <doc>
  6169. <![CDATA[Open the output generated by this format.]]>
  6170. </doc>
  6171. </method>
  6172. <method name="getEntry" return="org.apache.hadoop.io.Writable"
  6173. abstract="false" native="false" synchronized="false"
  6174. static="true" final="false" visibility="public"
  6175. deprecated="not deprecated">
  6176. <param name="readers" type="org.apache.hadoop.io.MapFile.Reader[]"/>
  6177. <param name="partitioner" type="org.apache.hadoop.mapred.Partitioner"/>
  6178. <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
  6179. <param name="value" type="org.apache.hadoop.io.Writable"/>
  6180. <exception name="IOException" type="java.io.IOException"/>
  6181. <doc>
  6182. <![CDATA[Get an entry from output generated by this class.]]>
  6183. </doc>
  6184. </method>
  6185. <doc>
  6186. <![CDATA[An {@link OutputFormat} that writes {@link MapFile}s.]]>
  6187. </doc>
  6188. </class>
  6189. <!-- end class org.apache.hadoop.mapred.MapFileOutputFormat -->
  6190. <!-- start interface org.apache.hadoop.mapred.Mapper -->
  6191. <interface name="Mapper" abstract="true"
  6192. static="false" final="false" visibility="public"
  6193. deprecated="Use {@link org.apache.hadoop.mapreduce.Mapper} instead.">
  6194. <implements name="org.apache.hadoop.mapred.JobConfigurable"/>
  6195. <implements name="org.apache.hadoop.io.Closeable"/>
  6196. <method name="map"
  6197. abstract="false" native="false" synchronized="false"
  6198. static="false" final="false" visibility="public"
  6199. deprecated="not deprecated">
  6200. <param name="key" type="java.lang.Object"/>
  6201. <param name="value" type="java.lang.Object"/>
  6202. <param name="output" type="org.apache.hadoop.mapred.OutputCollector"/>
  6203. <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
  6204. <exception name="IOException" type="java.io.IOException"/>
  6205. <doc>
  6206. <![CDATA[Maps a single input key/value pair into an intermediate key/value pair.
  6207. <p>Output pairs need not be of the same types as input pairs. A given
  6208. input pair may map to zero or many output pairs. Output pairs are
  6209. collected with calls to
  6210. {@link OutputCollector#collect(Object,Object)}.</p>
  6211. <p>Applications can use the {@link Reporter} provided to report progress
  6212. or just indicate that they are alive. In scenarios where the application
  6213. takes an insignificant amount of time to process individual key/value
  6214. pairs, this is crucial since the framework might assume that the task has
  6215. timed-out and kill that task. The other way of avoiding this is to set
  6216. <a href="{@docRoot}/../mapred-default.html#mapred.task.timeout">
  6217. mapred.task.timeout</a> to a high-enough value (or even zero for no
  6218. time-outs).</p>
  6219. @param key the input key.
  6220. @param value the input value.
  6221. @param output collects mapped keys and values.
  6222. @param reporter facility to report progress.]]>
  6223. </doc>
  6224. </method>
  6225. <doc>
  6226. <![CDATA[Maps input key/value pairs to a set of intermediate key/value pairs.
  6227. <p>Maps are the individual tasks which transform input records into a
  6228. intermediate records. The transformed intermediate records need not be of
  6229. the same type as the input records. A given input pair may map to zero or
  6230. many output pairs.</p>
  6231. <p>The Hadoop Map-Reduce framework spawns one map task for each
  6232. {@link InputSplit} generated by the {@link InputFormat} for the job.
  6233. <code>Mapper</code> implementations can access the {@link JobConf} for the
  6234. job via the {@link JobConfigurable#configure(JobConf)} and initialize
  6235. themselves. Similarly they can use the {@link Closeable#close()} method for
  6236. de-initialization.</p>
  6237. <p>The framework then calls
  6238. {@link #map(Object, Object, OutputCollector, Reporter)}
  6239. for each key/value pair in the <code>InputSplit</code> for that task.</p>
  6240. <p>All intermediate values associated with a given output key are
  6241. subsequently grouped by the framework, and passed to a {@link Reducer} to
  6242. determine the final output. Users can control the grouping by specifying
  6243. a <code>Comparator</code> via
  6244. {@link JobConf#setOutputKeyComparatorClass(Class)}.</p>
  6245. <p>The grouped <code>Mapper</code> outputs are partitioned per
  6246. <code>Reducer</code>. Users can control which keys (and hence records) go to
  6247. which <code>Reducer</code> by implementing a custom {@link Partitioner}.
  6248. <p>Users can optionally specify a <code>combiner</code>, via
  6249. {@link JobConf#setCombinerClass(Class)}, to perform local aggregation of the
  6250. intermediate outputs, which helps to cut down the amount of data transferred
  6251. from the <code>Mapper</code> to the <code>Reducer</code>.
  6252. <p>The intermediate, grouped outputs are always stored in
  6253. {@link SequenceFile}s. Applications can specify if and how the intermediate
  6254. outputs are to be compressed and which {@link CompressionCodec}s are to be
  6255. used via the <code>JobConf</code>.</p>
  6256. <p>If the job has
  6257. <a href="{@docRoot}/org/apache/hadoop/mapred/JobConf.html#ReducerNone">zero
  6258. reduces</a> then the output of the <code>Mapper</code> is directly written
  6259. to the {@link FileSystem} without grouping by keys.</p>
  6260. <p>Example:</p>
  6261. <p><blockquote><pre>
  6262. public class MyMapper&lt;K extends WritableComparable, V extends Writable&gt;
  6263. extends MapReduceBase implements Mapper&lt;K, V, K, V&gt; {
  6264. static enum MyCounters { NUM_RECORDS }
  6265. private String mapTaskId;
  6266. private String inputFile;
  6267. private int noRecords = 0;
  6268. public void configure(JobConf job) {
  6269. mapTaskId = job.get("mapred.task.id");
  6270. inputFile = job.get("map.input.file");
  6271. }
  6272. public void map(K key, V val,
  6273. OutputCollector&lt;K, V&gt; output, Reporter reporter)
  6274. throws IOException {
  6275. // Process the &lt;key, value&gt; pair (assume this takes a while)
  6276. // ...
  6277. // ...
  6278. // Let the framework know that we are alive, and kicking!
  6279. // reporter.progress();
  6280. // Process some more
  6281. // ...
  6282. // ...
  6283. // Increment the no. of &lt;key, value&gt; pairs processed
  6284. ++noRecords;
  6285. // Increment counters
  6286. reporter.incrCounter(NUM_RECORDS, 1);
  6287. // Every 100 records update application-level status
  6288. if ((noRecords%100) == 0) {
  6289. reporter.setStatus(mapTaskId + " processed " + noRecords +
  6290. " from input-file: " + inputFile);
  6291. }
  6292. // Output the result
  6293. output.collect(key, val);
  6294. }
  6295. }
  6296. </pre></blockquote></p>
  6297. <p>Applications may write a custom {@link MapRunnable} to exert greater
  6298. control on map processing e.g. multi-threaded <code>Mapper</code>s etc.</p>
  6299. @see JobConf
  6300. @see InputFormat
  6301. @see Partitioner
  6302. @see Reducer
  6303. @see MapReduceBase
  6304. @see MapRunnable
  6305. @see SequenceFile
  6306. @deprecated Use {@link org.apache.hadoop.mapreduce.Mapper} instead.]]>
  6307. </doc>
  6308. </interface>
  6309. <!-- end interface org.apache.hadoop.mapred.Mapper -->
  6310. <!-- start class org.apache.hadoop.mapred.MapReduceBase -->
  6311. <class name="MapReduceBase" extends="java.lang.Object"
  6312. abstract="false"
  6313. static="false" final="false" visibility="public"
  6314. deprecated="not deprecated">
  6315. <implements name="org.apache.hadoop.io.Closeable"/>
  6316. <implements name="org.apache.hadoop.mapred.JobConfigurable"/>
  6317. <constructor name="MapReduceBase"
  6318. static="false" final="false" visibility="public"
  6319. deprecated="not deprecated">
  6320. </constructor>
  6321. <method name="close"
  6322. abstract="false" native="false" synchronized="false"
  6323. static="false" final="false" visibility="public"
  6324. deprecated="not deprecated">
  6325. <exception name="IOException" type="java.io.IOException"/>
  6326. <doc>
  6327. <![CDATA[Default implementation that does nothing.]]>
  6328. </doc>
  6329. </method>
  6330. <method name="configure"
  6331. abstract="false" native="false" synchronized="false"
  6332. static="false" final="false" visibility="public"
  6333. deprecated="not deprecated">
  6334. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  6335. <doc>
  6336. <![CDATA[Default implementation that does nothing.]]>
  6337. </doc>
  6338. </method>
  6339. <doc>
  6340. <![CDATA[Base class for {@link Mapper} and {@link Reducer} implementations.
  6341. <p>Provides default no-op implementations for a few methods, most non-trivial
  6342. applications need to override some of them.</p>]]>
  6343. </doc>
  6344. </class>
  6345. <!-- end class org.apache.hadoop.mapred.MapReduceBase -->
  6346. <!-- start class org.apache.hadoop.mapred.MapReducePolicyProvider -->
  6347. <class name="MapReducePolicyProvider" extends="org.apache.hadoop.security.authorize.PolicyProvider"
  6348. abstract="false"
  6349. static="false" final="false" visibility="public"
  6350. deprecated="not deprecated">
  6351. <constructor name="MapReducePolicyProvider"
  6352. static="false" final="false" visibility="public"
  6353. deprecated="not deprecated">
  6354. </constructor>
  6355. <method name="getServices" return="org.apache.hadoop.security.authorize.Service[]"
  6356. abstract="false" native="false" synchronized="false"
  6357. static="false" final="false" visibility="public"
  6358. deprecated="not deprecated">
  6359. </method>
  6360. <doc>
  6361. <![CDATA[{@link PolicyProvider} for Map-Reduce protocols.]]>
  6362. </doc>
  6363. </class>
  6364. <!-- end class org.apache.hadoop.mapred.MapReducePolicyProvider -->
  6365. <!-- start interface org.apache.hadoop.mapred.MapRunnable -->
  6366. <interface name="MapRunnable" abstract="true"
  6367. static="false" final="false" visibility="public"
  6368. deprecated="Use {@link org.apache.hadoop.mapreduce.Mapper} instead.">
  6369. <implements name="org.apache.hadoop.mapred.JobConfigurable"/>
  6370. <method name="run"
  6371. abstract="false" native="false" synchronized="false"
  6372. static="false" final="false" visibility="public"
  6373. deprecated="not deprecated">
  6374. <param name="input" type="org.apache.hadoop.mapred.RecordReader"/>
  6375. <param name="output" type="org.apache.hadoop.mapred.OutputCollector"/>
  6376. <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
  6377. <exception name="IOException" type="java.io.IOException"/>
  6378. <doc>
  6379. <![CDATA[Start mapping input <tt>&lt;key, value&gt;</tt> pairs.
  6380. <p>Mapping of input records to output records is complete when this method
  6381. returns.</p>
  6382. @param input the {@link RecordReader} to read the input records.
  6383. @param output the {@link OutputCollector} to collect the outputrecords.
  6384. @param reporter {@link Reporter} to report progress, status-updates etc.
  6385. @throws IOException]]>
  6386. </doc>
  6387. </method>
  6388. <doc>
  6389. <![CDATA[Expert: Generic interface for {@link Mapper}s.
  6390. <p>Custom implementations of <code>MapRunnable</code> can exert greater
  6391. control on map processing e.g. multi-threaded, asynchronous mappers etc.</p>
  6392. @see Mapper
  6393. @deprecated Use {@link org.apache.hadoop.mapreduce.Mapper} instead.]]>
  6394. </doc>
  6395. </interface>
  6396. <!-- end interface org.apache.hadoop.mapred.MapRunnable -->
  6397. <!-- start class org.apache.hadoop.mapred.MapRunner -->
  6398. <class name="MapRunner" extends="java.lang.Object"
  6399. abstract="false"
  6400. static="false" final="false" visibility="public"
  6401. deprecated="not deprecated">
  6402. <implements name="org.apache.hadoop.mapred.MapRunnable"/>
  6403. <constructor name="MapRunner"
  6404. static="false" final="false" visibility="public"
  6405. deprecated="not deprecated">
  6406. </constructor>
  6407. <method name="configure"
  6408. abstract="false" native="false" synchronized="false"
  6409. static="false" final="false" visibility="public"
  6410. deprecated="not deprecated">
  6411. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  6412. </method>
  6413. <method name="run"
  6414. abstract="false" native="false" synchronized="false"
  6415. static="false" final="false" visibility="public"
  6416. deprecated="not deprecated">
  6417. <param name="input" type="org.apache.hadoop.mapred.RecordReader"/>
  6418. <param name="output" type="org.apache.hadoop.mapred.OutputCollector"/>
  6419. <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
  6420. <exception name="IOException" type="java.io.IOException"/>
  6421. </method>
  6422. <method name="getMapper" return="org.apache.hadoop.mapred.Mapper"
  6423. abstract="false" native="false" synchronized="false"
  6424. static="false" final="false" visibility="protected"
  6425. deprecated="not deprecated">
  6426. </method>
  6427. <doc>
  6428. <![CDATA[Default {@link MapRunnable} implementation.]]>
  6429. </doc>
  6430. </class>
  6431. <!-- end class org.apache.hadoop.mapred.MapRunner -->
  6432. <!-- start class org.apache.hadoop.mapred.MultiFileInputFormat -->
  6433. <class name="MultiFileInputFormat" extends="org.apache.hadoop.mapred.FileInputFormat"
  6434. abstract="true"
  6435. static="false" final="false" visibility="public"
  6436. deprecated="Use {@link org.apache.hadoop.mapred.lib.CombineFileInputFormat} instead">
  6437. <constructor name="MultiFileInputFormat"
  6438. static="false" final="false" visibility="public"
  6439. deprecated="not deprecated">
  6440. </constructor>
  6441. <method name="getSplits" return="org.apache.hadoop.mapred.InputSplit[]"
  6442. abstract="false" native="false" synchronized="false"
  6443. static="false" final="false" visibility="public"
  6444. deprecated="not deprecated">
  6445. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  6446. <param name="numSplits" type="int"/>
  6447. <exception name="IOException" type="java.io.IOException"/>
  6448. </method>
  6449. <method name="getRecordReader" return="org.apache.hadoop.mapred.RecordReader"
  6450. abstract="true" native="false" synchronized="false"
  6451. static="false" final="false" visibility="public"
  6452. deprecated="not deprecated">
  6453. <param name="split" type="org.apache.hadoop.mapred.InputSplit"/>
  6454. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  6455. <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
  6456. <exception name="IOException" type="java.io.IOException"/>
  6457. </method>
  6458. <doc>
  6459. <![CDATA[An abstract {@link InputFormat} that returns {@link MultiFileSplit}'s
  6460. in {@link #getSplits(JobConf, int)} method. Splits are constructed from
  6461. the files under the input paths. Each split returned contains <i>nearly</i>
  6462. equal content length. <br>
  6463. Subclasses implement {@link #getRecordReader(InputSplit, JobConf, Reporter)}
  6464. to construct <code>RecordReader</code>'s for <code>MultiFileSplit</code>'s.
  6465. @see MultiFileSplit
  6466. @deprecated Use {@link org.apache.hadoop.mapred.lib.CombineFileInputFormat} instead]]>
  6467. </doc>
  6468. </class>
  6469. <!-- end class org.apache.hadoop.mapred.MultiFileInputFormat -->
  6470. <!-- start class org.apache.hadoop.mapred.MultiFileSplit -->
  6471. <class name="MultiFileSplit" extends="org.apache.hadoop.mapred.lib.CombineFileSplit"
  6472. abstract="false"
  6473. static="false" final="false" visibility="public"
  6474. deprecated="Use {@link org.apache.hadoop.mapred.lib.CombineFileSplit} instead">
  6475. <constructor name="MultiFileSplit" type="org.apache.hadoop.mapred.JobConf, org.apache.hadoop.fs.Path[], long[]"
  6476. static="false" final="false" visibility="public"
  6477. deprecated="not deprecated">
  6478. </constructor>
  6479. <method name="getLocations" return="java.lang.String[]"
  6480. abstract="false" native="false" synchronized="false"
  6481. static="false" final="false" visibility="public"
  6482. deprecated="not deprecated">
  6483. <exception name="IOException" type="java.io.IOException"/>
  6484. </method>
  6485. <method name="toString" return="java.lang.String"
  6486. abstract="false" native="false" synchronized="false"
  6487. static="false" final="false" visibility="public"
  6488. deprecated="not deprecated">
  6489. </method>
  6490. <doc>
  6491. <![CDATA[A sub-collection of input files. Unlike {@link FileSplit}, MultiFileSplit
  6492. class does not represent a split of a file, but a split of input files
  6493. into smaller sets. The atomic unit of split is a file. <br>
  6494. MultiFileSplit can be used to implement {@link RecordReader}'s, with
  6495. reading one record per file.
  6496. @see FileSplit
  6497. @see MultiFileInputFormat
  6498. @deprecated Use {@link org.apache.hadoop.mapred.lib.CombineFileSplit} instead]]>
  6499. </doc>
  6500. </class>
  6501. <!-- end class org.apache.hadoop.mapred.MultiFileSplit -->
  6502. <!-- start interface org.apache.hadoop.mapred.OutputCollector -->
  6503. <interface name="OutputCollector" abstract="true"
  6504. static="false" final="false" visibility="public"
  6505. deprecated="not deprecated">
  6506. <method name="collect"
  6507. abstract="false" native="false" synchronized="false"
  6508. static="false" final="false" visibility="public"
  6509. deprecated="not deprecated">
  6510. <param name="key" type="java.lang.Object"/>
  6511. <param name="value" type="java.lang.Object"/>
  6512. <exception name="IOException" type="java.io.IOException"/>
  6513. <doc>
  6514. <![CDATA[Adds a key/value pair to the output.
  6515. @param key the key to collect.
  6516. @param value to value to collect.
  6517. @throws IOException]]>
  6518. </doc>
  6519. </method>
  6520. <doc>
  6521. <![CDATA[Collects the <code>&lt;key, value&gt;</code> pairs output by {@link Mapper}s
  6522. and {@link Reducer}s.
  6523. <p><code>OutputCollector</code> is the generalization of the facility
  6524. provided by the Map-Reduce framework to collect data output by either the
  6525. <code>Mapper</code> or the <code>Reducer</code> i.e. intermediate outputs
  6526. or the output of the job.</p>]]>
  6527. </doc>
  6528. </interface>
  6529. <!-- end interface org.apache.hadoop.mapred.OutputCollector -->
  6530. <!-- start class org.apache.hadoop.mapred.OutputCommitter -->
  6531. <class name="OutputCommitter" extends="org.apache.hadoop.mapreduce.OutputCommitter"
  6532. abstract="true"
  6533. static="false" final="false" visibility="public"
  6534. deprecated="Use {@link org.apache.hadoop.mapreduce.OutputCommitter} instead.">
  6535. <constructor name="OutputCommitter"
  6536. static="false" final="false" visibility="public"
  6537. deprecated="not deprecated">
  6538. </constructor>
  6539. <method name="setupJob"
  6540. abstract="true" native="false" synchronized="false"
  6541. static="false" final="false" visibility="public"
  6542. deprecated="not deprecated">
  6543. <param name="jobContext" type="org.apache.hadoop.mapred.JobContext"/>
  6544. <exception name="IOException" type="java.io.IOException"/>
  6545. <doc>
  6546. <![CDATA[For the framework to setup the job output during initialization
  6547. @param jobContext Context of the job whose output is being written.
  6548. @throws IOException if temporary output could not be created]]>
  6549. </doc>
  6550. </method>
  6551. <method name="cleanupJob"
  6552. abstract="true" native="false" synchronized="false"
  6553. static="false" final="false" visibility="public"
  6554. deprecated="not deprecated">
  6555. <param name="jobContext" type="org.apache.hadoop.mapred.JobContext"/>
  6556. <exception name="IOException" type="java.io.IOException"/>
  6557. <doc>
  6558. <![CDATA[For cleaning up the job's output after job completion
  6559. @param jobContext Context of the job whose output is being written.
  6560. @throws IOException]]>
  6561. </doc>
  6562. </method>
  6563. <method name="setupTask"
  6564. abstract="true" native="false" synchronized="false"
  6565. static="false" final="false" visibility="public"
  6566. deprecated="not deprecated">
  6567. <param name="taskContext" type="org.apache.hadoop.mapred.TaskAttemptContext"/>
  6568. <exception name="IOException" type="java.io.IOException"/>
  6569. <doc>
  6570. <![CDATA[Sets up output for the task.
  6571. @param taskContext Context of the task whose output is being written.
  6572. @throws IOException]]>
  6573. </doc>
  6574. </method>
  6575. <method name="needsTaskCommit" return="boolean"
  6576. abstract="true" native="false" synchronized="false"
  6577. static="false" final="false" visibility="public"
  6578. deprecated="not deprecated">
  6579. <param name="taskContext" type="org.apache.hadoop.mapred.TaskAttemptContext"/>
  6580. <exception name="IOException" type="java.io.IOException"/>
  6581. <doc>
  6582. <![CDATA[Check whether task needs a commit
  6583. @param taskContext
  6584. @return true/false
  6585. @throws IOException]]>
  6586. </doc>
  6587. </method>
  6588. <method name="commitTask"
  6589. abstract="true" native="false" synchronized="false"
  6590. static="false" final="false" visibility="public"
  6591. deprecated="not deprecated">
  6592. <param name="taskContext" type="org.apache.hadoop.mapred.TaskAttemptContext"/>
  6593. <exception name="IOException" type="java.io.IOException"/>
  6594. <doc>
  6595. <![CDATA[To promote the task's temporary output to final output location
  6596. The task's output is moved to the job's output directory.
  6597. @param taskContext Context of the task whose output is being written.
  6598. @throws IOException if commit is not]]>
  6599. </doc>
  6600. </method>
  6601. <method name="abortTask"
  6602. abstract="true" native="false" synchronized="false"
  6603. static="false" final="false" visibility="public"
  6604. deprecated="not deprecated">
  6605. <param name="taskContext" type="org.apache.hadoop.mapred.TaskAttemptContext"/>
  6606. <exception name="IOException" type="java.io.IOException"/>
  6607. <doc>
  6608. <![CDATA[Discard the task output
  6609. @param taskContext
  6610. @throws IOException]]>
  6611. </doc>
  6612. </method>
  6613. <method name="setupJob"
  6614. abstract="false" native="false" synchronized="false"
  6615. static="false" final="true" visibility="public"
  6616. deprecated="not deprecated">
  6617. <param name="jobContext" type="org.apache.hadoop.mapreduce.JobContext"/>
  6618. <exception name="IOException" type="java.io.IOException"/>
  6619. <doc>
  6620. <![CDATA[This method implements the new interface by calling the old method. Note
  6621. that the input types are different between the new and old apis and this
  6622. is a bridge between the two.]]>
  6623. </doc>
  6624. </method>
  6625. <method name="cleanupJob"
  6626. abstract="false" native="false" synchronized="false"
  6627. static="false" final="true" visibility="public"
  6628. deprecated="not deprecated">
  6629. <param name="context" type="org.apache.hadoop.mapreduce.JobContext"/>
  6630. <exception name="IOException" type="java.io.IOException"/>
  6631. <doc>
  6632. <![CDATA[This method implements the new interface by calling the old method. Note
  6633. that the input types are different between the new and old apis and this
  6634. is a bridge between the two.]]>
  6635. </doc>
  6636. </method>
  6637. <method name="setupTask"
  6638. abstract="false" native="false" synchronized="false"
  6639. static="false" final="true" visibility="public"
  6640. deprecated="not deprecated">
  6641. <param name="taskContext" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
  6642. <exception name="IOException" type="java.io.IOException"/>
  6643. <doc>
  6644. <![CDATA[This method implements the new interface by calling the old method. Note
  6645. that the input types are different between the new and old apis and this
  6646. is a bridge between the two.]]>
  6647. </doc>
  6648. </method>
  6649. <method name="needsTaskCommit" return="boolean"
  6650. abstract="false" native="false" synchronized="false"
  6651. static="false" final="true" visibility="public"
  6652. deprecated="not deprecated">
  6653. <param name="taskContext" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
  6654. <exception name="IOException" type="java.io.IOException"/>
  6655. <doc>
  6656. <![CDATA[This method implements the new interface by calling the old method. Note
  6657. that the input types are different between the new and old apis and this
  6658. is a bridge between the two.]]>
  6659. </doc>
  6660. </method>
  6661. <method name="commitTask"
  6662. abstract="false" native="false" synchronized="false"
  6663. static="false" final="true" visibility="public"
  6664. deprecated="not deprecated">
  6665. <param name="taskContext" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
  6666. <exception name="IOException" type="java.io.IOException"/>
  6667. <doc>
  6668. <![CDATA[This method implements the new interface by calling the old method. Note
  6669. that the input types are different between the new and old apis and this
  6670. is a bridge between the two.]]>
  6671. </doc>
  6672. </method>
  6673. <method name="abortTask"
  6674. abstract="false" native="false" synchronized="false"
  6675. static="false" final="true" visibility="public"
  6676. deprecated="not deprecated">
  6677. <param name="taskContext" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
  6678. <exception name="IOException" type="java.io.IOException"/>
  6679. <doc>
  6680. <![CDATA[This method implements the new interface by calling the old method. Note
  6681. that the input types are different between the new and old apis and this
  6682. is a bridge between the two.]]>
  6683. </doc>
  6684. </method>
  6685. <doc>
  6686. <![CDATA[<code>OutputCommitter</code> describes the commit of task output for a
  6687. Map-Reduce job.
  6688. <p>The Map-Reduce framework relies on the <code>OutputCommitter</code> of
  6689. the job to:<p>
  6690. <ol>
  6691. <li>
  6692. Setup the job during initialization. For example, create the temporary
  6693. output directory for the job during the initialization of the job.
  6694. </li>
  6695. <li>
  6696. Cleanup the job after the job completion. For example, remove the
  6697. temporary output directory after the job completion.
  6698. </li>
  6699. <li>
  6700. Setup the task temporary output.
  6701. </li>
  6702. <li>
  6703. Check whether a task needs a commit. This is to avoid the commit
  6704. procedure if a task does not need commit.
  6705. </li>
  6706. <li>
  6707. Commit of the task output.
  6708. </li>
  6709. <li>
  6710. Discard the task commit.
  6711. </li>
  6712. </ol>
  6713. @see FileOutputCommitter
  6714. @see JobContext
  6715. @see TaskAttemptContext
  6716. @deprecated Use {@link org.apache.hadoop.mapreduce.OutputCommitter} instead.]]>
  6717. </doc>
  6718. </class>
  6719. <!-- end class org.apache.hadoop.mapred.OutputCommitter -->
  6720. <!-- start interface org.apache.hadoop.mapred.OutputFormat -->
  6721. <interface name="OutputFormat" abstract="true"
  6722. static="false" final="false" visibility="public"
  6723. deprecated="Use {@link org.apache.hadoop.mapreduce.OutputFormat} instead.">
  6724. <method name="getRecordWriter" return="org.apache.hadoop.mapred.RecordWriter"
  6725. abstract="false" native="false" synchronized="false"
  6726. static="false" final="false" visibility="public"
  6727. deprecated="not deprecated">
  6728. <param name="ignored" type="org.apache.hadoop.fs.FileSystem"/>
  6729. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  6730. <param name="name" type="java.lang.String"/>
  6731. <param name="progress" type="org.apache.hadoop.util.Progressable"/>
  6732. <exception name="IOException" type="java.io.IOException"/>
  6733. <doc>
  6734. <![CDATA[Get the {@link RecordWriter} for the given job.
  6735. @param ignored
  6736. @param job configuration for the job whose output is being written.
  6737. @param name the unique name for this part of the output.
  6738. @param progress mechanism for reporting progress while writing to file.
  6739. @return a {@link RecordWriter} to write the output for the job.
  6740. @throws IOException]]>
  6741. </doc>
  6742. </method>
  6743. <method name="checkOutputSpecs"
  6744. abstract="false" native="false" synchronized="false"
  6745. static="false" final="false" visibility="public"
  6746. deprecated="not deprecated">
  6747. <param name="ignored" type="org.apache.hadoop.fs.FileSystem"/>
  6748. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  6749. <exception name="IOException" type="java.io.IOException"/>
  6750. <doc>
  6751. <![CDATA[Check for validity of the output-specification for the job.
  6752. <p>This is to validate the output specification for the job when it is
  6753. a job is submitted. Typically checks that it does not already exist,
  6754. throwing an exception when it already exists, so that output is not
  6755. overwritten.</p>
  6756. @param ignored
  6757. @param job job configuration.
  6758. @throws IOException when output should not be attempted]]>
  6759. </doc>
  6760. </method>
  6761. <doc>
  6762. <![CDATA[<code>OutputFormat</code> describes the output-specification for a
  6763. Map-Reduce job.
  6764. <p>The Map-Reduce framework relies on the <code>OutputFormat</code> of the
  6765. job to:<p>
  6766. <ol>
  6767. <li>
  6768. Validate the output-specification of the job. For e.g. check that the
  6769. output directory doesn't already exist.
  6770. <li>
  6771. Provide the {@link RecordWriter} implementation to be used to write out
  6772. the output files of the job. Output files are stored in a
  6773. {@link FileSystem}.
  6774. </li>
  6775. </ol>
  6776. @see RecordWriter
  6777. @see JobConf
  6778. @deprecated Use {@link org.apache.hadoop.mapreduce.OutputFormat} instead.]]>
  6779. </doc>
  6780. </interface>
  6781. <!-- end interface org.apache.hadoop.mapred.OutputFormat -->
  6782. <!-- start class org.apache.hadoop.mapred.OutputLogFilter -->
  6783. <class name="OutputLogFilter" extends="java.lang.Object"
  6784. abstract="false"
  6785. static="false" final="false" visibility="public"
  6786. deprecated="not deprecated">
  6787. <implements name="org.apache.hadoop.fs.PathFilter"/>
  6788. <constructor name="OutputLogFilter"
  6789. static="false" final="false" visibility="public"
  6790. deprecated="not deprecated">
  6791. </constructor>
  6792. <method name="accept" return="boolean"
  6793. abstract="false" native="false" synchronized="false"
  6794. static="false" final="false" visibility="public"
  6795. deprecated="not deprecated">
  6796. <param name="path" type="org.apache.hadoop.fs.Path"/>
  6797. </method>
  6798. <doc>
  6799. <![CDATA[This class filters log files from directory given
  6800. It doesnt accept paths having _logs.
  6801. This can be used to list paths of output directory as follows:
  6802. Path[] fileList = FileUtil.stat2Paths(fs.listStatus(outDir,
  6803. new OutputLogFilter()));]]>
  6804. </doc>
  6805. </class>
  6806. <!-- end class org.apache.hadoop.mapred.OutputLogFilter -->
  6807. <!-- start interface org.apache.hadoop.mapred.Partitioner -->
  6808. <interface name="Partitioner" abstract="true"
  6809. static="false" final="false" visibility="public"
  6810. deprecated="Use {@link org.apache.hadoop.mapreduce.Partitioner} instead.">
  6811. <implements name="org.apache.hadoop.mapred.JobConfigurable"/>
  6812. <method name="getPartition" return="int"
  6813. abstract="false" native="false" synchronized="false"
  6814. static="false" final="false" visibility="public"
  6815. deprecated="not deprecated">
  6816. <param name="key" type="java.lang.Object"/>
  6817. <param name="value" type="java.lang.Object"/>
  6818. <param name="numPartitions" type="int"/>
  6819. <doc>
  6820. <![CDATA[Get the paritition number for a given key (hence record) given the total
  6821. number of partitions i.e. number of reduce-tasks for the job.
  6822. <p>Typically a hash function on a all or a subset of the key.</p>
  6823. @param key the key to be paritioned.
  6824. @param value the entry value.
  6825. @param numPartitions the total number of partitions.
  6826. @return the partition number for the <code>key</code>.]]>
  6827. </doc>
  6828. </method>
  6829. <doc>
  6830. <![CDATA[Partitions the key space.
  6831. <p><code>Partitioner</code> controls the partitioning of the keys of the
  6832. intermediate map-outputs. The key (or a subset of the key) is used to derive
  6833. the partition, typically by a hash function. The total number of partitions
  6834. is the same as the number of reduce tasks for the job. Hence this controls
  6835. which of the <code>m</code> reduce tasks the intermediate key (and hence the
  6836. record) is sent for reduction.</p>
  6837. @see Reducer
  6838. @deprecated Use {@link org.apache.hadoop.mapreduce.Partitioner} instead.]]>
  6839. </doc>
  6840. </interface>
  6841. <!-- end interface org.apache.hadoop.mapred.Partitioner -->
  6842. <!-- start interface org.apache.hadoop.mapred.RawKeyValueIterator -->
  6843. <interface name="RawKeyValueIterator" abstract="true"
  6844. static="false" final="false" visibility="public"
  6845. deprecated="not deprecated">
  6846. <method name="getKey" return="org.apache.hadoop.io.DataInputBuffer"
  6847. abstract="false" native="false" synchronized="false"
  6848. static="false" final="false" visibility="public"
  6849. deprecated="not deprecated">
  6850. <exception name="IOException" type="java.io.IOException"/>
  6851. <doc>
  6852. <![CDATA[Gets the current raw key.
  6853. @return Gets the current raw key as a DataInputBuffer
  6854. @throws IOException]]>
  6855. </doc>
  6856. </method>
  6857. <method name="getValue" return="org.apache.hadoop.io.DataInputBuffer"
  6858. abstract="false" native="false" synchronized="false"
  6859. static="false" final="false" visibility="public"
  6860. deprecated="not deprecated">
  6861. <exception name="IOException" type="java.io.IOException"/>
  6862. <doc>
  6863. <![CDATA[Gets the current raw value.
  6864. @return Gets the current raw value as a DataInputBuffer
  6865. @throws IOException]]>
  6866. </doc>
  6867. </method>
  6868. <method name="next" return="boolean"
  6869. abstract="false" native="false" synchronized="false"
  6870. static="false" final="false" visibility="public"
  6871. deprecated="not deprecated">
  6872. <exception name="IOException" type="java.io.IOException"/>
  6873. <doc>
  6874. <![CDATA[Sets up the current key and value (for getKey and getValue).
  6875. @return <code>true</code> if there exists a key/value,
  6876. <code>false</code> otherwise.
  6877. @throws IOException]]>
  6878. </doc>
  6879. </method>
  6880. <method name="close"
  6881. abstract="false" native="false" synchronized="false"
  6882. static="false" final="false" visibility="public"
  6883. deprecated="not deprecated">
  6884. <exception name="IOException" type="java.io.IOException"/>
  6885. <doc>
  6886. <![CDATA[Closes the iterator so that the underlying streams can be closed.
  6887. @throws IOException]]>
  6888. </doc>
  6889. </method>
  6890. <method name="getProgress" return="org.apache.hadoop.util.Progress"
  6891. abstract="false" native="false" synchronized="false"
  6892. static="false" final="false" visibility="public"
  6893. deprecated="not deprecated">
  6894. <doc>
  6895. <![CDATA[Gets the Progress object; this has a float (0.0 - 1.0)
  6896. indicating the bytes processed by the iterator so far]]>
  6897. </doc>
  6898. </method>
  6899. <doc>
  6900. <![CDATA[<code>RawKeyValueIterator</code> is an iterator used to iterate over
  6901. the raw keys and values during sort/merge of intermediate data.]]>
  6902. </doc>
  6903. </interface>
  6904. <!-- end interface org.apache.hadoop.mapred.RawKeyValueIterator -->
  6905. <!-- start interface org.apache.hadoop.mapred.RecordReader -->
  6906. <interface name="RecordReader" abstract="true"
  6907. static="false" final="false" visibility="public"
  6908. deprecated="not deprecated">
  6909. <method name="next" return="boolean"
  6910. abstract="false" native="false" synchronized="false"
  6911. static="false" final="false" visibility="public"
  6912. deprecated="not deprecated">
  6913. <param name="key" type="java.lang.Object"/>
  6914. <param name="value" type="java.lang.Object"/>
  6915. <exception name="IOException" type="java.io.IOException"/>
  6916. <doc>
  6917. <![CDATA[Reads the next key/value pair from the input for processing.
  6918. @param key the key to read data into
  6919. @param value the value to read data into
  6920. @return true iff a key/value was read, false if at EOF]]>
  6921. </doc>
  6922. </method>
  6923. <method name="createKey" return="java.lang.Object"
  6924. abstract="false" native="false" synchronized="false"
  6925. static="false" final="false" visibility="public"
  6926. deprecated="not deprecated">
  6927. <doc>
  6928. <![CDATA[Create an object of the appropriate type to be used as a key.
  6929. @return a new key object.]]>
  6930. </doc>
  6931. </method>
  6932. <method name="createValue" return="java.lang.Object"
  6933. abstract="false" native="false" synchronized="false"
  6934. static="false" final="false" visibility="public"
  6935. deprecated="not deprecated">
  6936. <doc>
  6937. <![CDATA[Create an object of the appropriate type to be used as a value.
  6938. @return a new value object.]]>
  6939. </doc>
  6940. </method>
  6941. <method name="getPos" return="long"
  6942. abstract="false" native="false" synchronized="false"
  6943. static="false" final="false" visibility="public"
  6944. deprecated="not deprecated">
  6945. <exception name="IOException" type="java.io.IOException"/>
  6946. <doc>
  6947. <![CDATA[Returns the current position in the input.
  6948. @return the current position in the input.
  6949. @throws IOException]]>
  6950. </doc>
  6951. </method>
  6952. <method name="close"
  6953. abstract="false" native="false" synchronized="false"
  6954. static="false" final="false" visibility="public"
  6955. deprecated="not deprecated">
  6956. <exception name="IOException" type="java.io.IOException"/>
  6957. <doc>
  6958. <![CDATA[Close this {@link InputSplit} to future operations.
  6959. @throws IOException]]>
  6960. </doc>
  6961. </method>
  6962. <method name="getProgress" return="float"
  6963. abstract="false" native="false" synchronized="false"
  6964. static="false" final="false" visibility="public"
  6965. deprecated="not deprecated">
  6966. <exception name="IOException" type="java.io.IOException"/>
  6967. <doc>
  6968. <![CDATA[How much of the input has the {@link RecordReader} consumed i.e.
  6969. has been processed by?
  6970. @return progress from <code>0.0</code> to <code>1.0</code>.
  6971. @throws IOException]]>
  6972. </doc>
  6973. </method>
  6974. <doc>
  6975. <![CDATA[<code>RecordReader</code> reads &lt;key, value&gt; pairs from an
  6976. {@link InputSplit}.
  6977. <p><code>RecordReader</code>, typically, converts the byte-oriented view of
  6978. the input, provided by the <code>InputSplit</code>, and presents a
  6979. record-oriented view for the {@link Mapper} & {@link Reducer} tasks for
  6980. processing. It thus assumes the responsibility of processing record
  6981. boundaries and presenting the tasks with keys and values.</p>
  6982. @see InputSplit
  6983. @see InputFormat]]>
  6984. </doc>
  6985. </interface>
  6986. <!-- end interface org.apache.hadoop.mapred.RecordReader -->
  6987. <!-- start interface org.apache.hadoop.mapred.RecordWriter -->
  6988. <interface name="RecordWriter" abstract="true"
  6989. static="false" final="false" visibility="public"
  6990. deprecated="not deprecated">
  6991. <method name="write"
  6992. abstract="false" native="false" synchronized="false"
  6993. static="false" final="false" visibility="public"
  6994. deprecated="not deprecated">
  6995. <param name="key" type="java.lang.Object"/>
  6996. <param name="value" type="java.lang.Object"/>
  6997. <exception name="IOException" type="java.io.IOException"/>
  6998. <doc>
  6999. <![CDATA[Writes a key/value pair.
  7000. @param key the key to write.
  7001. @param value the value to write.
  7002. @throws IOException]]>
  7003. </doc>
  7004. </method>
  7005. <method name="close"
  7006. abstract="false" native="false" synchronized="false"
  7007. static="false" final="false" visibility="public"
  7008. deprecated="not deprecated">
  7009. <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
  7010. <exception name="IOException" type="java.io.IOException"/>
  7011. <doc>
  7012. <![CDATA[Close this <code>RecordWriter</code> to future operations.
  7013. @param reporter facility to report progress.
  7014. @throws IOException]]>
  7015. </doc>
  7016. </method>
  7017. <doc>
  7018. <![CDATA[<code>RecordWriter</code> writes the output &lt;key, value&gt; pairs
  7019. to an output file.
  7020. <p><code>RecordWriter</code> implementations write the job outputs to the
  7021. {@link FileSystem}.
  7022. @see OutputFormat]]>
  7023. </doc>
  7024. </interface>
  7025. <!-- end interface org.apache.hadoop.mapred.RecordWriter -->
  7026. <!-- start interface org.apache.hadoop.mapred.Reducer -->
  7027. <interface name="Reducer" abstract="true"
  7028. static="false" final="false" visibility="public"
  7029. deprecated="Use {@link org.apache.hadoop.mapreduce.Reducer} instead.">
  7030. <implements name="org.apache.hadoop.mapred.JobConfigurable"/>
  7031. <implements name="org.apache.hadoop.io.Closeable"/>
  7032. <method name="reduce"
  7033. abstract="false" native="false" synchronized="false"
  7034. static="false" final="false" visibility="public"
  7035. deprecated="not deprecated">
  7036. <param name="key" type="java.lang.Object"/>
  7037. <param name="values" type="java.util.Iterator"/>
  7038. <param name="output" type="org.apache.hadoop.mapred.OutputCollector"/>
  7039. <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
  7040. <exception name="IOException" type="java.io.IOException"/>
  7041. <doc>
  7042. <![CDATA[<i>Reduces</i> values for a given key.
  7043. <p>The framework calls this method for each
  7044. <code>&lt;key, (list of values)></code> pair in the grouped inputs.
  7045. Output values must be of the same type as input values. Input keys must
  7046. not be altered. The framework will <b>reuse</b> the key and value objects
  7047. that are passed into the reduce, therefore the application should clone
  7048. the objects they want to keep a copy of. In many cases, all values are
  7049. combined into zero or one value.
  7050. </p>
  7051. <p>Output pairs are collected with calls to
  7052. {@link OutputCollector#collect(Object,Object)}.</p>
  7053. <p>Applications can use the {@link Reporter} provided to report progress
  7054. or just indicate that they are alive. In scenarios where the application
  7055. takes an insignificant amount of time to process individual key/value
  7056. pairs, this is crucial since the framework might assume that the task has
  7057. timed-out and kill that task. The other way of avoiding this is to set
  7058. <a href="{@docRoot}/../mapred-default.html#mapred.task.timeout">
  7059. mapred.task.timeout</a> to a high-enough value (or even zero for no
  7060. time-outs).</p>
  7061. @param key the key.
  7062. @param values the list of values to reduce.
  7063. @param output to collect keys and combined values.
  7064. @param reporter facility to report progress.]]>
  7065. </doc>
  7066. </method>
  7067. <doc>
  7068. <![CDATA[Reduces a set of intermediate values which share a key to a smaller set of
  7069. values.
  7070. <p>The number of <code>Reducer</code>s for the job is set by the user via
  7071. {@link JobConf#setNumReduceTasks(int)}. <code>Reducer</code> implementations
  7072. can access the {@link JobConf} for the job via the
  7073. {@link JobConfigurable#configure(JobConf)} method and initialize themselves.
  7074. Similarly they can use the {@link Closeable#close()} method for
  7075. de-initialization.</p>
  7076. <p><code>Reducer</code> has 3 primary phases:</p>
  7077. <ol>
  7078. <li>
  7079. <h4 id="Shuffle">Shuffle</h4>
  7080. <p><code>Reducer</code> is input the grouped output of a {@link Mapper}.
  7081. In the phase the framework, for each <code>Reducer</code>, fetches the
  7082. relevant partition of the output of all the <code>Mapper</code>s, via HTTP.
  7083. </p>
  7084. </li>
  7085. <li>
  7086. <h4 id="Sort">Sort</h4>
  7087. <p>The framework groups <code>Reducer</code> inputs by <code>key</code>s
  7088. (since different <code>Mapper</code>s may have output the same key) in this
  7089. stage.</p>
  7090. <p>The shuffle and sort phases occur simultaneously i.e. while outputs are
  7091. being fetched they are merged.</p>
  7092. <h5 id="SecondarySort">SecondarySort</h5>
  7093. <p>If equivalence rules for keys while grouping the intermediates are
  7094. different from those for grouping keys before reduction, then one may
  7095. specify a <code>Comparator</code> via
  7096. {@link JobConf#setOutputValueGroupingComparator(Class)}.Since
  7097. {@link JobConf#setOutputKeyComparatorClass(Class)} can be used to
  7098. control how intermediate keys are grouped, these can be used in conjunction
  7099. to simulate <i>secondary sort on values</i>.</p>
  7100. For example, say that you want to find duplicate web pages and tag them
  7101. all with the url of the "best" known example. You would set up the job
  7102. like:
  7103. <ul>
  7104. <li>Map Input Key: url</li>
  7105. <li>Map Input Value: document</li>
  7106. <li>Map Output Key: document checksum, url pagerank</li>
  7107. <li>Map Output Value: url</li>
  7108. <li>Partitioner: by checksum</li>
  7109. <li>OutputKeyComparator: by checksum and then decreasing pagerank</li>
  7110. <li>OutputValueGroupingComparator: by checksum</li>
  7111. </ul>
  7112. </li>
  7113. <li>
  7114. <h4 id="Reduce">Reduce</h4>
  7115. <p>In this phase the
  7116. {@link #reduce(Object, Iterator, OutputCollector, Reporter)}
  7117. method is called for each <code>&lt;key, (list of values)></code> pair in
  7118. the grouped inputs.</p>
  7119. <p>The output of the reduce task is typically written to the
  7120. {@link FileSystem} via
  7121. {@link OutputCollector#collect(Object, Object)}.</p>
  7122. </li>
  7123. </ol>
  7124. <p>The output of the <code>Reducer</code> is <b>not re-sorted</b>.</p>
  7125. <p>Example:</p>
  7126. <p><blockquote><pre>
  7127. public class MyReducer&lt;K extends WritableComparable, V extends Writable&gt;
  7128. extends MapReduceBase implements Reducer&lt;K, V, K, V&gt; {
  7129. static enum MyCounters { NUM_RECORDS }
  7130. private String reduceTaskId;
  7131. private int noKeys = 0;
  7132. public void configure(JobConf job) {
  7133. reduceTaskId = job.get("mapred.task.id");
  7134. }
  7135. public void reduce(K key, Iterator&lt;V&gt; values,
  7136. OutputCollector&lt;K, V&gt; output,
  7137. Reporter reporter)
  7138. throws IOException {
  7139. // Process
  7140. int noValues = 0;
  7141. while (values.hasNext()) {
  7142. V value = values.next();
  7143. // Increment the no. of values for this key
  7144. ++noValues;
  7145. // Process the &lt;key, value&gt; pair (assume this takes a while)
  7146. // ...
  7147. // ...
  7148. // Let the framework know that we are alive, and kicking!
  7149. if ((noValues%10) == 0) {
  7150. reporter.progress();
  7151. }
  7152. // Process some more
  7153. // ...
  7154. // ...
  7155. // Output the &lt;key, value&gt;
  7156. output.collect(key, value);
  7157. }
  7158. // Increment the no. of &lt;key, list of values&gt; pairs processed
  7159. ++noKeys;
  7160. // Increment counters
  7161. reporter.incrCounter(NUM_RECORDS, 1);
  7162. // Every 100 keys update application-level status
  7163. if ((noKeys%100) == 0) {
  7164. reporter.setStatus(reduceTaskId + " processed " + noKeys);
  7165. }
  7166. }
  7167. }
  7168. </pre></blockquote></p>
  7169. @see Mapper
  7170. @see Partitioner
  7171. @see Reporter
  7172. @see MapReduceBase
  7173. @deprecated Use {@link org.apache.hadoop.mapreduce.Reducer} instead.]]>
  7174. </doc>
  7175. </interface>
  7176. <!-- end interface org.apache.hadoop.mapred.Reducer -->
  7177. <!-- start interface org.apache.hadoop.mapred.Reporter -->
  7178. <interface name="Reporter" abstract="true"
  7179. static="false" final="false" visibility="public"
  7180. deprecated="not deprecated">
  7181. <implements name="org.apache.hadoop.util.Progressable"/>
  7182. <method name="setStatus"
  7183. abstract="false" native="false" synchronized="false"
  7184. static="false" final="false" visibility="public"
  7185. deprecated="not deprecated">
  7186. <param name="status" type="java.lang.String"/>
  7187. <doc>
  7188. <![CDATA[Set the status description for the task.
  7189. @param status brief description of the current status.]]>
  7190. </doc>
  7191. </method>
  7192. <method name="getCounter" return="org.apache.hadoop.mapred.Counters.Counter"
  7193. abstract="false" native="false" synchronized="false"
  7194. static="false" final="false" visibility="public"
  7195. deprecated="not deprecated">
  7196. <param name="name" type="java.lang.Enum"/>
  7197. <doc>
  7198. <![CDATA[Get the {@link Counter} of the given group with the given name.
  7199. @param name counter name
  7200. @return the <code>Counter</code> of the given group/name.]]>
  7201. </doc>
  7202. </method>
  7203. <method name="getCounter" return="org.apache.hadoop.mapred.Counters.Counter"
  7204. abstract="false" native="false" synchronized="false"
  7205. static="false" final="false" visibility="public"
  7206. deprecated="not deprecated">
  7207. <param name="group" type="java.lang.String"/>
  7208. <param name="name" type="java.lang.String"/>
  7209. <doc>
  7210. <![CDATA[Get the {@link Counter} of the given group with the given name.
  7211. @param group counter group
  7212. @param name counter name
  7213. @return the <code>Counter</code> of the given group/name.]]>
  7214. </doc>
  7215. </method>
  7216. <method name="incrCounter"
  7217. abstract="false" native="false" synchronized="false"
  7218. static="false" final="false" visibility="public"
  7219. deprecated="not deprecated">
  7220. <param name="key" type="java.lang.Enum"/>
  7221. <param name="amount" type="long"/>
  7222. <doc>
  7223. <![CDATA[Increments the counter identified by the key, which can be of
  7224. any {@link Enum} type, by the specified amount.
  7225. @param key key to identify the counter to be incremented. The key can be
  7226. be any <code>Enum</code>.
  7227. @param amount A non-negative amount by which the counter is to
  7228. be incremented.]]>
  7229. </doc>
  7230. </method>
  7231. <method name="incrCounter"
  7232. abstract="false" native="false" synchronized="false"
  7233. static="false" final="false" visibility="public"
  7234. deprecated="not deprecated">
  7235. <param name="group" type="java.lang.String"/>
  7236. <param name="counter" type="java.lang.String"/>
  7237. <param name="amount" type="long"/>
  7238. <doc>
  7239. <![CDATA[Increments the counter identified by the group and counter name
  7240. by the specified amount.
  7241. @param group name to identify the group of the counter to be incremented.
  7242. @param counter name to identify the counter within the group.
  7243. @param amount A non-negative amount by which the counter is to
  7244. be incremented.]]>
  7245. </doc>
  7246. </method>
  7247. <method name="getInputSplit" return="org.apache.hadoop.mapred.InputSplit"
  7248. abstract="false" native="false" synchronized="false"
  7249. static="false" final="false" visibility="public"
  7250. deprecated="not deprecated">
  7251. <exception name="UnsupportedOperationException" type="java.lang.UnsupportedOperationException"/>
  7252. <doc>
  7253. <![CDATA[Get the {@link InputSplit} object for a map.
  7254. @return the <code>InputSplit</code> that the map is reading from.
  7255. @throws UnsupportedOperationException if called outside a mapper]]>
  7256. </doc>
  7257. </method>
  7258. <field name="NULL" type="org.apache.hadoop.mapred.Reporter"
  7259. transient="false" volatile="false"
  7260. static="true" final="true" visibility="public"
  7261. deprecated="not deprecated">
  7262. <doc>
  7263. <![CDATA[A constant of Reporter type that does nothing.]]>
  7264. </doc>
  7265. </field>
  7266. <doc>
  7267. <![CDATA[A facility for Map-Reduce applications to report progress and update
  7268. counters, status information etc.
  7269. <p>{@link Mapper} and {@link Reducer} can use the <code>Reporter</code>
  7270. provided to report progress or just indicate that they are alive. In
  7271. scenarios where the application takes an insignificant amount of time to
  7272. process individual key/value pairs, this is crucial since the framework
  7273. might assume that the task has timed-out and kill that task.
  7274. <p>Applications can also update {@link Counters} via the provided
  7275. <code>Reporter</code> .</p>
  7276. @see Progressable
  7277. @see Counters]]>
  7278. </doc>
  7279. </interface>
  7280. <!-- end interface org.apache.hadoop.mapred.Reporter -->
  7281. <!-- start interface org.apache.hadoop.mapred.RunningJob -->
  7282. <interface name="RunningJob" abstract="true"
  7283. static="false" final="false" visibility="public"
  7284. deprecated="not deprecated">
  7285. <method name="getID" return="org.apache.hadoop.mapred.JobID"
  7286. abstract="false" native="false" synchronized="false"
  7287. static="false" final="false" visibility="public"
  7288. deprecated="not deprecated">
  7289. <doc>
  7290. <![CDATA[Get the job identifier.
  7291. @return the job identifier.]]>
  7292. </doc>
  7293. </method>
  7294. <method name="getJobID" return="java.lang.String"
  7295. abstract="false" native="false" synchronized="false"
  7296. static="false" final="false" visibility="public"
  7297. deprecated="This method is deprecated and will be removed. Applications should
  7298. rather use {@link #getID()}.">
  7299. <doc>
  7300. <![CDATA[@deprecated This method is deprecated and will be removed. Applications should
  7301. rather use {@link #getID()}.]]>
  7302. </doc>
  7303. </method>
  7304. <method name="getJobName" return="java.lang.String"
  7305. abstract="false" native="false" synchronized="false"
  7306. static="false" final="false" visibility="public"
  7307. deprecated="not deprecated">
  7308. <doc>
  7309. <![CDATA[Get the name of the job.
  7310. @return the name of the job.]]>
  7311. </doc>
  7312. </method>
  7313. <method name="getJobFile" return="java.lang.String"
  7314. abstract="false" native="false" synchronized="false"
  7315. static="false" final="false" visibility="public"
  7316. deprecated="not deprecated">
  7317. <doc>
  7318. <![CDATA[Get the path of the submitted job configuration.
  7319. @return the path of the submitted job configuration.]]>
  7320. </doc>
  7321. </method>
  7322. <method name="getTrackingURL" return="java.lang.String"
  7323. abstract="false" native="false" synchronized="false"
  7324. static="false" final="false" visibility="public"
  7325. deprecated="not deprecated">
  7326. <doc>
  7327. <![CDATA[Get the URL where some job progress information will be displayed.
  7328. @return the URL where some job progress information will be displayed.]]>
  7329. </doc>
  7330. </method>
  7331. <method name="mapProgress" return="float"
  7332. abstract="false" native="false" synchronized="false"
  7333. static="false" final="false" visibility="public"
  7334. deprecated="not deprecated">
  7335. <exception name="IOException" type="java.io.IOException"/>
  7336. <doc>
  7337. <![CDATA[Get the <i>progress</i> of the job's map-tasks, as a float between 0.0
  7338. and 1.0. When all map tasks have completed, the function returns 1.0.
  7339. @return the progress of the job's map-tasks.
  7340. @throws IOException]]>
  7341. </doc>
  7342. </method>
  7343. <method name="reduceProgress" return="float"
  7344. abstract="false" native="false" synchronized="false"
  7345. static="false" final="false" visibility="public"
  7346. deprecated="not deprecated">
  7347. <exception name="IOException" type="java.io.IOException"/>
  7348. <doc>
  7349. <![CDATA[Get the <i>progress</i> of the job's reduce-tasks, as a float between 0.0
  7350. and 1.0. When all reduce tasks have completed, the function returns 1.0.
  7351. @return the progress of the job's reduce-tasks.
  7352. @throws IOException]]>
  7353. </doc>
  7354. </method>
  7355. <method name="cleanupProgress" return="float"
  7356. abstract="false" native="false" synchronized="false"
  7357. static="false" final="false" visibility="public"
  7358. deprecated="not deprecated">
  7359. <exception name="IOException" type="java.io.IOException"/>
  7360. <doc>
  7361. <![CDATA[Get the <i>progress</i> of the job's cleanup-tasks, as a float between 0.0
  7362. and 1.0. When all cleanup tasks have completed, the function returns 1.0.
  7363. @return the progress of the job's cleanup-tasks.
  7364. @throws IOException]]>
  7365. </doc>
  7366. </method>
  7367. <method name="setupProgress" return="float"
  7368. abstract="false" native="false" synchronized="false"
  7369. static="false" final="false" visibility="public"
  7370. deprecated="not deprecated">
  7371. <exception name="IOException" type="java.io.IOException"/>
  7372. <doc>
  7373. <![CDATA[Get the <i>progress</i> of the job's setup-tasks, as a float between 0.0
  7374. and 1.0. When all setup tasks have completed, the function returns 1.0.
  7375. @return the progress of the job's setup-tasks.
  7376. @throws IOException]]>
  7377. </doc>
  7378. </method>
  7379. <method name="isComplete" return="boolean"
  7380. abstract="false" native="false" synchronized="false"
  7381. static="false" final="false" visibility="public"
  7382. deprecated="not deprecated">
  7383. <exception name="IOException" type="java.io.IOException"/>
  7384. <doc>
  7385. <![CDATA[Check if the job is finished or not.
  7386. This is a non-blocking call.
  7387. @return <code>true</code> if the job is complete, else <code>false</code>.
  7388. @throws IOException]]>
  7389. </doc>
  7390. </method>
  7391. <method name="isSuccessful" return="boolean"
  7392. abstract="false" native="false" synchronized="false"
  7393. static="false" final="false" visibility="public"
  7394. deprecated="not deprecated">
  7395. <exception name="IOException" type="java.io.IOException"/>
  7396. <doc>
  7397. <![CDATA[Check if the job completed successfully.
  7398. @return <code>true</code> if the job succeeded, else <code>false</code>.
  7399. @throws IOException]]>
  7400. </doc>
  7401. </method>
  7402. <method name="waitForCompletion"
  7403. abstract="false" native="false" synchronized="false"
  7404. static="false" final="false" visibility="public"
  7405. deprecated="not deprecated">
  7406. <exception name="IOException" type="java.io.IOException"/>
  7407. <doc>
  7408. <![CDATA[Blocks until the job is complete.
  7409. @throws IOException]]>
  7410. </doc>
  7411. </method>
  7412. <method name="getJobState" return="int"
  7413. abstract="false" native="false" synchronized="false"
  7414. static="false" final="false" visibility="public"
  7415. deprecated="not deprecated">
  7416. <exception name="IOException" type="java.io.IOException"/>
  7417. <doc>
  7418. <![CDATA[Returns the current state of the Job.
  7419. {@link JobStatus}
  7420. @throws IOException]]>
  7421. </doc>
  7422. </method>
  7423. <method name="killJob"
  7424. abstract="false" native="false" synchronized="false"
  7425. static="false" final="false" visibility="public"
  7426. deprecated="not deprecated">
  7427. <exception name="IOException" type="java.io.IOException"/>
  7428. <doc>
  7429. <![CDATA[Kill the running job. Blocks until all job tasks have been
  7430. killed as well. If the job is no longer running, it simply returns.
  7431. @throws IOException]]>
  7432. </doc>
  7433. </method>
  7434. <method name="setJobPriority"
  7435. abstract="false" native="false" synchronized="false"
  7436. static="false" final="false" visibility="public"
  7437. deprecated="not deprecated">
  7438. <param name="priority" type="java.lang.String"/>
  7439. <exception name="IOException" type="java.io.IOException"/>
  7440. <doc>
  7441. <![CDATA[Set the priority of a running job.
  7442. @param priority the new priority for the job.
  7443. @throws IOException]]>
  7444. </doc>
  7445. </method>
  7446. <method name="getTaskCompletionEvents" return="org.apache.hadoop.mapred.TaskCompletionEvent[]"
  7447. abstract="false" native="false" synchronized="false"
  7448. static="false" final="false" visibility="public"
  7449. deprecated="not deprecated">
  7450. <param name="startFrom" type="int"/>
  7451. <exception name="IOException" type="java.io.IOException"/>
  7452. <doc>
  7453. <![CDATA[Get events indicating completion (success/failure) of component tasks.
  7454. @param startFrom index to start fetching events from
  7455. @return an array of {@link TaskCompletionEvent}s
  7456. @throws IOException]]>
  7457. </doc>
  7458. </method>
  7459. <method name="killTask"
  7460. abstract="false" native="false" synchronized="false"
  7461. static="false" final="false" visibility="public"
  7462. deprecated="not deprecated">
  7463. <param name="taskId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  7464. <param name="shouldFail" type="boolean"/>
  7465. <exception name="IOException" type="java.io.IOException"/>
  7466. <doc>
  7467. <![CDATA[Kill indicated task attempt.
  7468. @param taskId the id of the task to be terminated.
  7469. @param shouldFail if true the task is failed and added to failed tasks
  7470. list, otherwise it is just killed, w/o affecting
  7471. job failure status.
  7472. @throws IOException]]>
  7473. </doc>
  7474. </method>
  7475. <method name="killTask"
  7476. abstract="false" native="false" synchronized="false"
  7477. static="false" final="false" visibility="public"
  7478. deprecated="Applications should rather use {@link #killTask(TaskAttemptID, boolean)}">
  7479. <param name="taskId" type="java.lang.String"/>
  7480. <param name="shouldFail" type="boolean"/>
  7481. <exception name="IOException" type="java.io.IOException"/>
  7482. <doc>
  7483. <![CDATA[@deprecated Applications should rather use {@link #killTask(TaskAttemptID, boolean)}]]>
  7484. </doc>
  7485. </method>
  7486. <method name="getCounters" return="org.apache.hadoop.mapred.Counters"
  7487. abstract="false" native="false" synchronized="false"
  7488. static="false" final="false" visibility="public"
  7489. deprecated="not deprecated">
  7490. <exception name="IOException" type="java.io.IOException"/>
  7491. <doc>
  7492. <![CDATA[Gets the counters for this job.
  7493. @return the counters for this job.
  7494. @throws IOException]]>
  7495. </doc>
  7496. </method>
  7497. <method name="getTaskDiagnostics" return="java.lang.String[]"
  7498. abstract="false" native="false" synchronized="false"
  7499. static="false" final="false" visibility="public"
  7500. deprecated="not deprecated">
  7501. <param name="taskid" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  7502. <exception name="IOException" type="java.io.IOException"/>
  7503. <doc>
  7504. <![CDATA[Gets the diagnostic messages for a given task attempt.
  7505. @param taskid
  7506. @return the list of diagnostic messages for the task
  7507. @throws IOException]]>
  7508. </doc>
  7509. </method>
  7510. <doc>
  7511. <![CDATA[<code>RunningJob</code> is the user-interface to query for details on a
  7512. running Map-Reduce job.
  7513. <p>Clients can get hold of <code>RunningJob</code> via the {@link JobClient}
  7514. and then query the running-job for details such as name, configuration,
  7515. progress etc.</p>
  7516. @see JobClient]]>
  7517. </doc>
  7518. </interface>
  7519. <!-- end interface org.apache.hadoop.mapred.RunningJob -->
  7520. <!-- start class org.apache.hadoop.mapred.SequenceFileAsBinaryInputFormat -->
  7521. <class name="SequenceFileAsBinaryInputFormat" extends="org.apache.hadoop.mapred.SequenceFileInputFormat"
  7522. abstract="false"
  7523. static="false" final="false" visibility="public"
  7524. deprecated="not deprecated">
  7525. <constructor name="SequenceFileAsBinaryInputFormat"
  7526. static="false" final="false" visibility="public"
  7527. deprecated="not deprecated">
  7528. </constructor>
  7529. <method name="getRecordReader" return="org.apache.hadoop.mapred.RecordReader"
  7530. abstract="false" native="false" synchronized="false"
  7531. static="false" final="false" visibility="public"
  7532. deprecated="not deprecated">
  7533. <param name="split" type="org.apache.hadoop.mapred.InputSplit"/>
  7534. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  7535. <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
  7536. <exception name="IOException" type="java.io.IOException"/>
  7537. </method>
  7538. <doc>
  7539. <![CDATA[InputFormat reading keys, values from SequenceFiles in binary (raw)
  7540. format.]]>
  7541. </doc>
  7542. </class>
  7543. <!-- end class org.apache.hadoop.mapred.SequenceFileAsBinaryInputFormat -->
  7544. <!-- start class org.apache.hadoop.mapred.SequenceFileAsBinaryInputFormat.SequenceFileAsBinaryRecordReader -->
  7545. <class name="SequenceFileAsBinaryInputFormat.SequenceFileAsBinaryRecordReader" extends="java.lang.Object"
  7546. abstract="false"
  7547. static="true" final="false" visibility="public"
  7548. deprecated="not deprecated">
  7549. <implements name="org.apache.hadoop.mapred.RecordReader"/>
  7550. <constructor name="SequenceFileAsBinaryInputFormat.SequenceFileAsBinaryRecordReader" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.mapred.FileSplit"
  7551. static="false" final="false" visibility="public"
  7552. deprecated="not deprecated">
  7553. <exception name="IOException" type="java.io.IOException"/>
  7554. </constructor>
  7555. <method name="createKey" return="org.apache.hadoop.io.BytesWritable"
  7556. abstract="false" native="false" synchronized="false"
  7557. static="false" final="false" visibility="public"
  7558. deprecated="not deprecated">
  7559. </method>
  7560. <method name="createValue" return="org.apache.hadoop.io.BytesWritable"
  7561. abstract="false" native="false" synchronized="false"
  7562. static="false" final="false" visibility="public"
  7563. deprecated="not deprecated">
  7564. </method>
  7565. <method name="getKeyClassName" return="java.lang.String"
  7566. abstract="false" native="false" synchronized="false"
  7567. static="false" final="false" visibility="public"
  7568. deprecated="not deprecated">
  7569. <doc>
  7570. <![CDATA[Retrieve the name of the key class for this SequenceFile.
  7571. @see org.apache.hadoop.io.SequenceFile.Reader#getKeyClassName]]>
  7572. </doc>
  7573. </method>
  7574. <method name="getValueClassName" return="java.lang.String"
  7575. abstract="false" native="false" synchronized="false"
  7576. static="false" final="false" visibility="public"
  7577. deprecated="not deprecated">
  7578. <doc>
  7579. <![CDATA[Retrieve the name of the value class for this SequenceFile.
  7580. @see org.apache.hadoop.io.SequenceFile.Reader#getValueClassName]]>
  7581. </doc>
  7582. </method>
  7583. <method name="next" return="boolean"
  7584. abstract="false" native="false" synchronized="true"
  7585. static="false" final="false" visibility="public"
  7586. deprecated="not deprecated">
  7587. <param name="key" type="org.apache.hadoop.io.BytesWritable"/>
  7588. <param name="val" type="org.apache.hadoop.io.BytesWritable"/>
  7589. <exception name="IOException" type="java.io.IOException"/>
  7590. <doc>
  7591. <![CDATA[Read raw bytes from a SequenceFile.]]>
  7592. </doc>
  7593. </method>
  7594. <method name="getPos" return="long"
  7595. abstract="false" native="false" synchronized="false"
  7596. static="false" final="false" visibility="public"
  7597. deprecated="not deprecated">
  7598. <exception name="IOException" type="java.io.IOException"/>
  7599. </method>
  7600. <method name="close"
  7601. abstract="false" native="false" synchronized="false"
  7602. static="false" final="false" visibility="public"
  7603. deprecated="not deprecated">
  7604. <exception name="IOException" type="java.io.IOException"/>
  7605. </method>
  7606. <method name="getProgress" return="float"
  7607. abstract="false" native="false" synchronized="false"
  7608. static="false" final="false" visibility="public"
  7609. deprecated="not deprecated">
  7610. <exception name="IOException" type="java.io.IOException"/>
  7611. <doc>
  7612. <![CDATA[Return the progress within the input split
  7613. @return 0.0 to 1.0 of the input byte range]]>
  7614. </doc>
  7615. </method>
  7616. <doc>
  7617. <![CDATA[Read records from a SequenceFile as binary (raw) bytes.]]>
  7618. </doc>
  7619. </class>
  7620. <!-- end class org.apache.hadoop.mapred.SequenceFileAsBinaryInputFormat.SequenceFileAsBinaryRecordReader -->
  7621. <!-- start class org.apache.hadoop.mapred.SequenceFileAsBinaryOutputFormat -->
  7622. <class name="SequenceFileAsBinaryOutputFormat" extends="org.apache.hadoop.mapred.SequenceFileOutputFormat"
  7623. abstract="false"
  7624. static="false" final="false" visibility="public"
  7625. deprecated="not deprecated">
  7626. <constructor name="SequenceFileAsBinaryOutputFormat"
  7627. static="false" final="false" visibility="public"
  7628. deprecated="not deprecated">
  7629. </constructor>
  7630. <method name="setSequenceFileOutputKeyClass"
  7631. abstract="false" native="false" synchronized="false"
  7632. static="true" final="false" visibility="public"
  7633. deprecated="not deprecated">
  7634. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  7635. <param name="theClass" type="java.lang.Class"/>
  7636. <doc>
  7637. <![CDATA[Set the key class for the {@link SequenceFile}
  7638. <p>This allows the user to specify the key class to be different
  7639. from the actual class ({@link BytesWritable}) used for writing </p>
  7640. @param conf the {@link JobConf} to modify
  7641. @param theClass the SequenceFile output key class.]]>
  7642. </doc>
  7643. </method>
  7644. <method name="setSequenceFileOutputValueClass"
  7645. abstract="false" native="false" synchronized="false"
  7646. static="true" final="false" visibility="public"
  7647. deprecated="not deprecated">
  7648. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  7649. <param name="theClass" type="java.lang.Class"/>
  7650. <doc>
  7651. <![CDATA[Set the value class for the {@link SequenceFile}
  7652. <p>This allows the user to specify the value class to be different
  7653. from the actual class ({@link BytesWritable}) used for writing </p>
  7654. @param conf the {@link JobConf} to modify
  7655. @param theClass the SequenceFile output key class.]]>
  7656. </doc>
  7657. </method>
  7658. <method name="getSequenceFileOutputKeyClass" return="java.lang.Class"
  7659. abstract="false" native="false" synchronized="false"
  7660. static="true" final="false" visibility="public"
  7661. deprecated="not deprecated">
  7662. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  7663. <doc>
  7664. <![CDATA[Get the key class for the {@link SequenceFile}
  7665. @return the key class of the {@link SequenceFile}]]>
  7666. </doc>
  7667. </method>
  7668. <method name="getSequenceFileOutputValueClass" return="java.lang.Class"
  7669. abstract="false" native="false" synchronized="false"
  7670. static="true" final="false" visibility="public"
  7671. deprecated="not deprecated">
  7672. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  7673. <doc>
  7674. <![CDATA[Get the value class for the {@link SequenceFile}
  7675. @return the value class of the {@link SequenceFile}]]>
  7676. </doc>
  7677. </method>
  7678. <method name="getRecordWriter" return="org.apache.hadoop.mapred.RecordWriter"
  7679. abstract="false" native="false" synchronized="false"
  7680. static="false" final="false" visibility="public"
  7681. deprecated="not deprecated">
  7682. <param name="ignored" type="org.apache.hadoop.fs.FileSystem"/>
  7683. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  7684. <param name="name" type="java.lang.String"/>
  7685. <param name="progress" type="org.apache.hadoop.util.Progressable"/>
  7686. <exception name="IOException" type="java.io.IOException"/>
  7687. </method>
  7688. <method name="checkOutputSpecs"
  7689. abstract="false" native="false" synchronized="false"
  7690. static="false" final="false" visibility="public"
  7691. deprecated="not deprecated">
  7692. <param name="ignored" type="org.apache.hadoop.fs.FileSystem"/>
  7693. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  7694. <exception name="IOException" type="java.io.IOException"/>
  7695. </method>
  7696. <doc>
  7697. <![CDATA[An {@link OutputFormat} that writes keys, values to
  7698. {@link SequenceFile}s in binary(raw) format]]>
  7699. </doc>
  7700. </class>
  7701. <!-- end class org.apache.hadoop.mapred.SequenceFileAsBinaryOutputFormat -->
  7702. <!-- start class org.apache.hadoop.mapred.SequenceFileAsBinaryOutputFormat.WritableValueBytes -->
  7703. <class name="SequenceFileAsBinaryOutputFormat.WritableValueBytes" extends="java.lang.Object"
  7704. abstract="false"
  7705. static="true" final="false" visibility="protected"
  7706. deprecated="not deprecated">
  7707. <implements name="org.apache.hadoop.io.SequenceFile.ValueBytes"/>
  7708. <constructor name="SequenceFileAsBinaryOutputFormat.WritableValueBytes"
  7709. static="false" final="false" visibility="public"
  7710. deprecated="not deprecated">
  7711. </constructor>
  7712. <constructor name="SequenceFileAsBinaryOutputFormat.WritableValueBytes" type="org.apache.hadoop.io.BytesWritable"
  7713. static="false" final="false" visibility="public"
  7714. deprecated="not deprecated">
  7715. </constructor>
  7716. <method name="reset"
  7717. abstract="false" native="false" synchronized="false"
  7718. static="false" final="false" visibility="public"
  7719. deprecated="not deprecated">
  7720. <param name="value" type="org.apache.hadoop.io.BytesWritable"/>
  7721. </method>
  7722. <method name="writeUncompressedBytes"
  7723. abstract="false" native="false" synchronized="false"
  7724. static="false" final="false" visibility="public"
  7725. deprecated="not deprecated">
  7726. <param name="outStream" type="java.io.DataOutputStream"/>
  7727. <exception name="IOException" type="java.io.IOException"/>
  7728. </method>
  7729. <method name="writeCompressedBytes"
  7730. abstract="false" native="false" synchronized="false"
  7731. static="false" final="false" visibility="public"
  7732. deprecated="not deprecated">
  7733. <param name="outStream" type="java.io.DataOutputStream"/>
  7734. <exception name="IllegalArgumentException" type="java.lang.IllegalArgumentException"/>
  7735. <exception name="IOException" type="java.io.IOException"/>
  7736. </method>
  7737. <method name="getSize" return="int"
  7738. abstract="false" native="false" synchronized="false"
  7739. static="false" final="false" visibility="public"
  7740. deprecated="not deprecated">
  7741. </method>
  7742. <doc>
  7743. <![CDATA[Inner class used for appendRaw]]>
  7744. </doc>
  7745. </class>
  7746. <!-- end class org.apache.hadoop.mapred.SequenceFileAsBinaryOutputFormat.WritableValueBytes -->
  7747. <!-- start class org.apache.hadoop.mapred.SequenceFileAsTextInputFormat -->
  7748. <class name="SequenceFileAsTextInputFormat" extends="org.apache.hadoop.mapred.SequenceFileInputFormat"
  7749. abstract="false"
  7750. static="false" final="false" visibility="public"
  7751. deprecated="not deprecated">
  7752. <constructor name="SequenceFileAsTextInputFormat"
  7753. static="false" final="false" visibility="public"
  7754. deprecated="not deprecated">
  7755. </constructor>
  7756. <method name="getRecordReader" return="org.apache.hadoop.mapred.RecordReader"
  7757. abstract="false" native="false" synchronized="false"
  7758. static="false" final="false" visibility="public"
  7759. deprecated="not deprecated">
  7760. <param name="split" type="org.apache.hadoop.mapred.InputSplit"/>
  7761. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  7762. <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
  7763. <exception name="IOException" type="java.io.IOException"/>
  7764. </method>
  7765. <doc>
  7766. <![CDATA[This class is similar to SequenceFileInputFormat, except it generates SequenceFileAsTextRecordReader
  7767. which converts the input keys and values to their String forms by calling toString() method.]]>
  7768. </doc>
  7769. </class>
  7770. <!-- end class org.apache.hadoop.mapred.SequenceFileAsTextInputFormat -->
  7771. <!-- start class org.apache.hadoop.mapred.SequenceFileAsTextRecordReader -->
  7772. <class name="SequenceFileAsTextRecordReader" extends="java.lang.Object"
  7773. abstract="false"
  7774. static="false" final="false" visibility="public"
  7775. deprecated="not deprecated">
  7776. <implements name="org.apache.hadoop.mapred.RecordReader"/>
  7777. <constructor name="SequenceFileAsTextRecordReader" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.mapred.FileSplit"
  7778. static="false" final="false" visibility="public"
  7779. deprecated="not deprecated">
  7780. <exception name="IOException" type="java.io.IOException"/>
  7781. </constructor>
  7782. <method name="createKey" return="org.apache.hadoop.io.Text"
  7783. abstract="false" native="false" synchronized="false"
  7784. static="false" final="false" visibility="public"
  7785. deprecated="not deprecated">
  7786. </method>
  7787. <method name="createValue" return="org.apache.hadoop.io.Text"
  7788. abstract="false" native="false" synchronized="false"
  7789. static="false" final="false" visibility="public"
  7790. deprecated="not deprecated">
  7791. </method>
  7792. <method name="next" return="boolean"
  7793. abstract="false" native="false" synchronized="true"
  7794. static="false" final="false" visibility="public"
  7795. deprecated="not deprecated">
  7796. <param name="key" type="org.apache.hadoop.io.Text"/>
  7797. <param name="value" type="org.apache.hadoop.io.Text"/>
  7798. <exception name="IOException" type="java.io.IOException"/>
  7799. <doc>
  7800. <![CDATA[Read key/value pair in a line.]]>
  7801. </doc>
  7802. </method>
  7803. <method name="getProgress" return="float"
  7804. abstract="false" native="false" synchronized="false"
  7805. static="false" final="false" visibility="public"
  7806. deprecated="not deprecated">
  7807. <exception name="IOException" type="java.io.IOException"/>
  7808. </method>
  7809. <method name="getPos" return="long"
  7810. abstract="false" native="false" synchronized="true"
  7811. static="false" final="false" visibility="public"
  7812. deprecated="not deprecated">
  7813. <exception name="IOException" type="java.io.IOException"/>
  7814. </method>
  7815. <method name="close"
  7816. abstract="false" native="false" synchronized="true"
  7817. static="false" final="false" visibility="public"
  7818. deprecated="not deprecated">
  7819. <exception name="IOException" type="java.io.IOException"/>
  7820. </method>
  7821. <doc>
  7822. <![CDATA[This class converts the input keys and values to their String forms by calling toString()
  7823. method. This class to SequenceFileAsTextInputFormat class is as LineRecordReader
  7824. class to TextInputFormat class.]]>
  7825. </doc>
  7826. </class>
  7827. <!-- end class org.apache.hadoop.mapred.SequenceFileAsTextRecordReader -->
  7828. <!-- start class org.apache.hadoop.mapred.SequenceFileInputFilter -->
  7829. <class name="SequenceFileInputFilter" extends="org.apache.hadoop.mapred.SequenceFileInputFormat"
  7830. abstract="false"
  7831. static="false" final="false" visibility="public"
  7832. deprecated="not deprecated">
  7833. <constructor name="SequenceFileInputFilter"
  7834. static="false" final="false" visibility="public"
  7835. deprecated="not deprecated">
  7836. </constructor>
  7837. <method name="getRecordReader" return="org.apache.hadoop.mapred.RecordReader"
  7838. abstract="false" native="false" synchronized="false"
  7839. static="false" final="false" visibility="public"
  7840. deprecated="not deprecated">
  7841. <param name="split" type="org.apache.hadoop.mapred.InputSplit"/>
  7842. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  7843. <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
  7844. <exception name="IOException" type="java.io.IOException"/>
  7845. <doc>
  7846. <![CDATA[Create a record reader for the given split
  7847. @param split file split
  7848. @param job job configuration
  7849. @param reporter reporter who sends report to task tracker
  7850. @return RecordReader]]>
  7851. </doc>
  7852. </method>
  7853. <method name="setFilterClass"
  7854. abstract="false" native="false" synchronized="false"
  7855. static="true" final="false" visibility="public"
  7856. deprecated="not deprecated">
  7857. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  7858. <param name="filterClass" type="java.lang.Class"/>
  7859. <doc>
  7860. <![CDATA[set the filter class
  7861. @param conf application configuration
  7862. @param filterClass filter class]]>
  7863. </doc>
  7864. </method>
  7865. <doc>
  7866. <![CDATA[A class that allows a map/red job to work on a sample of sequence files.
  7867. The sample is decided by the filter class set by the job.]]>
  7868. </doc>
  7869. </class>
  7870. <!-- end class org.apache.hadoop.mapred.SequenceFileInputFilter -->
  7871. <!-- start interface org.apache.hadoop.mapred.SequenceFileInputFilter.Filter -->
  7872. <interface name="SequenceFileInputFilter.Filter" abstract="true"
  7873. static="true" final="false" visibility="public"
  7874. deprecated="not deprecated">
  7875. <implements name="org.apache.hadoop.conf.Configurable"/>
  7876. <method name="accept" return="boolean"
  7877. abstract="false" native="false" synchronized="false"
  7878. static="false" final="false" visibility="public"
  7879. deprecated="not deprecated">
  7880. <param name="key" type="java.lang.Object"/>
  7881. <doc>
  7882. <![CDATA[filter function
  7883. Decide if a record should be filtered or not
  7884. @param key record key
  7885. @return true if a record is accepted; return false otherwise]]>
  7886. </doc>
  7887. </method>
  7888. <doc>
  7889. <![CDATA[filter interface]]>
  7890. </doc>
  7891. </interface>
  7892. <!-- end interface org.apache.hadoop.mapred.SequenceFileInputFilter.Filter -->
  7893. <!-- start class org.apache.hadoop.mapred.SequenceFileInputFilter.FilterBase -->
  7894. <class name="SequenceFileInputFilter.FilterBase" extends="java.lang.Object"
  7895. abstract="true"
  7896. static="true" final="false" visibility="public"
  7897. deprecated="not deprecated">
  7898. <implements name="org.apache.hadoop.mapred.SequenceFileInputFilter.Filter"/>
  7899. <constructor name="SequenceFileInputFilter.FilterBase"
  7900. static="false" final="false" visibility="public"
  7901. deprecated="not deprecated">
  7902. </constructor>
  7903. <method name="getConf" return="org.apache.hadoop.conf.Configuration"
  7904. abstract="false" native="false" synchronized="false"
  7905. static="false" final="false" visibility="public"
  7906. deprecated="not deprecated">
  7907. </method>
  7908. <doc>
  7909. <![CDATA[base class for Filters]]>
  7910. </doc>
  7911. </class>
  7912. <!-- end class org.apache.hadoop.mapred.SequenceFileInputFilter.FilterBase -->
  7913. <!-- start class org.apache.hadoop.mapred.SequenceFileInputFilter.MD5Filter -->
  7914. <class name="SequenceFileInputFilter.MD5Filter" extends="org.apache.hadoop.mapred.SequenceFileInputFilter.FilterBase"
  7915. abstract="false"
  7916. static="true" final="false" visibility="public"
  7917. deprecated="not deprecated">
  7918. <constructor name="SequenceFileInputFilter.MD5Filter"
  7919. static="false" final="false" visibility="public"
  7920. deprecated="not deprecated">
  7921. </constructor>
  7922. <method name="setFrequency"
  7923. abstract="false" native="false" synchronized="false"
  7924. static="true" final="false" visibility="public"
  7925. deprecated="not deprecated">
  7926. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  7927. <param name="frequency" type="int"/>
  7928. <doc>
  7929. <![CDATA[set the filtering frequency in configuration
  7930. @param conf configuration
  7931. @param frequency filtering frequency]]>
  7932. </doc>
  7933. </method>
  7934. <method name="setConf"
  7935. abstract="false" native="false" synchronized="false"
  7936. static="false" final="false" visibility="public"
  7937. deprecated="not deprecated">
  7938. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  7939. <doc>
  7940. <![CDATA[configure the filter according to configuration
  7941. @param conf configuration]]>
  7942. </doc>
  7943. </method>
  7944. <method name="accept" return="boolean"
  7945. abstract="false" native="false" synchronized="false"
  7946. static="false" final="false" visibility="public"
  7947. deprecated="not deprecated">
  7948. <param name="key" type="java.lang.Object"/>
  7949. <doc>
  7950. <![CDATA[Filtering method
  7951. If MD5(key) % frequency==0, return true; otherwise return false
  7952. @see org.apache.hadoop.mapred.SequenceFileInputFilter.Filter#accept(Object)]]>
  7953. </doc>
  7954. </method>
  7955. <field name="MD5_LEN" type="int"
  7956. transient="false" volatile="false"
  7957. static="true" final="true" visibility="public"
  7958. deprecated="not deprecated">
  7959. </field>
  7960. <doc>
  7961. <![CDATA[This class returns a set of records by examing the MD5 digest of its
  7962. key against a filtering frequency <i>f</i>. The filtering criteria is
  7963. MD5(key) % f == 0.]]>
  7964. </doc>
  7965. </class>
  7966. <!-- end class org.apache.hadoop.mapred.SequenceFileInputFilter.MD5Filter -->
  7967. <!-- start class org.apache.hadoop.mapred.SequenceFileInputFilter.PercentFilter -->
  7968. <class name="SequenceFileInputFilter.PercentFilter" extends="org.apache.hadoop.mapred.SequenceFileInputFilter.FilterBase"
  7969. abstract="false"
  7970. static="true" final="false" visibility="public"
  7971. deprecated="not deprecated">
  7972. <constructor name="SequenceFileInputFilter.PercentFilter"
  7973. static="false" final="false" visibility="public"
  7974. deprecated="not deprecated">
  7975. </constructor>
  7976. <method name="setFrequency"
  7977. abstract="false" native="false" synchronized="false"
  7978. static="true" final="false" visibility="public"
  7979. deprecated="not deprecated">
  7980. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  7981. <param name="frequency" type="int"/>
  7982. <doc>
  7983. <![CDATA[set the frequency and stores it in conf
  7984. @param conf configuration
  7985. @param frequency filtering frequencey]]>
  7986. </doc>
  7987. </method>
  7988. <method name="setConf"
  7989. abstract="false" native="false" synchronized="false"
  7990. static="false" final="false" visibility="public"
  7991. deprecated="not deprecated">
  7992. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  7993. <doc>
  7994. <![CDATA[configure the filter by checking the configuration
  7995. @param conf configuration]]>
  7996. </doc>
  7997. </method>
  7998. <method name="accept" return="boolean"
  7999. abstract="false" native="false" synchronized="false"
  8000. static="false" final="false" visibility="public"
  8001. deprecated="not deprecated">
  8002. <param name="key" type="java.lang.Object"/>
  8003. <doc>
  8004. <![CDATA[Filtering method
  8005. If record# % frequency==0, return true; otherwise return false
  8006. @see org.apache.hadoop.mapred.SequenceFileInputFilter.Filter#accept(Object)]]>
  8007. </doc>
  8008. </method>
  8009. <doc>
  8010. <![CDATA[This class returns a percentage of records
  8011. The percentage is determined by a filtering frequency <i>f</i> using
  8012. the criteria record# % f == 0.
  8013. For example, if the frequency is 10, one out of 10 records is returned.]]>
  8014. </doc>
  8015. </class>
  8016. <!-- end class org.apache.hadoop.mapred.SequenceFileInputFilter.PercentFilter -->
  8017. <!-- start class org.apache.hadoop.mapred.SequenceFileInputFilter.RegexFilter -->
  8018. <class name="SequenceFileInputFilter.RegexFilter" extends="org.apache.hadoop.mapred.SequenceFileInputFilter.FilterBase"
  8019. abstract="false"
  8020. static="true" final="false" visibility="public"
  8021. deprecated="not deprecated">
  8022. <constructor name="SequenceFileInputFilter.RegexFilter"
  8023. static="false" final="false" visibility="public"
  8024. deprecated="not deprecated">
  8025. </constructor>
  8026. <method name="setPattern"
  8027. abstract="false" native="false" synchronized="false"
  8028. static="true" final="false" visibility="public"
  8029. deprecated="not deprecated">
  8030. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  8031. <param name="regex" type="java.lang.String"/>
  8032. <exception name="PatternSyntaxException" type="java.util.regex.PatternSyntaxException"/>
  8033. <doc>
  8034. <![CDATA[Define the filtering regex and stores it in conf
  8035. @param conf where the regex is set
  8036. @param regex regex used as a filter]]>
  8037. </doc>
  8038. </method>
  8039. <method name="setConf"
  8040. abstract="false" native="false" synchronized="false"
  8041. static="false" final="false" visibility="public"
  8042. deprecated="not deprecated">
  8043. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  8044. <doc>
  8045. <![CDATA[configure the Filter by checking the configuration]]>
  8046. </doc>
  8047. </method>
  8048. <method name="accept" return="boolean"
  8049. abstract="false" native="false" synchronized="false"
  8050. static="false" final="false" visibility="public"
  8051. deprecated="not deprecated">
  8052. <param name="key" type="java.lang.Object"/>
  8053. <doc>
  8054. <![CDATA[Filtering method
  8055. If key matches the regex, return true; otherwise return false
  8056. @see org.apache.hadoop.mapred.SequenceFileInputFilter.Filter#accept(Object)]]>
  8057. </doc>
  8058. </method>
  8059. <doc>
  8060. <![CDATA[Records filter by matching key to regex]]>
  8061. </doc>
  8062. </class>
  8063. <!-- end class org.apache.hadoop.mapred.SequenceFileInputFilter.RegexFilter -->
  8064. <!-- start class org.apache.hadoop.mapred.SequenceFileInputFormat -->
  8065. <class name="SequenceFileInputFormat" extends="org.apache.hadoop.mapred.FileInputFormat"
  8066. abstract="false"
  8067. static="false" final="false" visibility="public"
  8068. deprecated="Use
  8069. {@link org.apache.hadoop.mapreduce.lib.input.SequenceFileInputFormat}
  8070. instead.">
  8071. <constructor name="SequenceFileInputFormat"
  8072. static="false" final="false" visibility="public"
  8073. deprecated="not deprecated">
  8074. </constructor>
  8075. <method name="listStatus" return="org.apache.hadoop.fs.FileStatus[]"
  8076. abstract="false" native="false" synchronized="false"
  8077. static="false" final="false" visibility="protected"
  8078. deprecated="not deprecated">
  8079. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  8080. <exception name="IOException" type="java.io.IOException"/>
  8081. </method>
  8082. <method name="getRecordReader" return="org.apache.hadoop.mapred.RecordReader"
  8083. abstract="false" native="false" synchronized="false"
  8084. static="false" final="false" visibility="public"
  8085. deprecated="not deprecated">
  8086. <param name="split" type="org.apache.hadoop.mapred.InputSplit"/>
  8087. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  8088. <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
  8089. <exception name="IOException" type="java.io.IOException"/>
  8090. </method>
  8091. <doc>
  8092. <![CDATA[An {@link InputFormat} for {@link SequenceFile}s.
  8093. @deprecated Use
  8094. {@link org.apache.hadoop.mapreduce.lib.input.SequenceFileInputFormat}
  8095. instead.]]>
  8096. </doc>
  8097. </class>
  8098. <!-- end class org.apache.hadoop.mapred.SequenceFileInputFormat -->
  8099. <!-- start class org.apache.hadoop.mapred.SequenceFileOutputFormat -->
  8100. <class name="SequenceFileOutputFormat" extends="org.apache.hadoop.mapred.FileOutputFormat"
  8101. abstract="false"
  8102. static="false" final="false" visibility="public"
  8103. deprecated="Use
  8104. {@link org.apache.hadoop.mapreduce.lib.output.SequenceFileOutputFormat}
  8105. instead.">
  8106. <constructor name="SequenceFileOutputFormat"
  8107. static="false" final="false" visibility="public"
  8108. deprecated="not deprecated">
  8109. </constructor>
  8110. <method name="getRecordWriter" return="org.apache.hadoop.mapred.RecordWriter"
  8111. abstract="false" native="false" synchronized="false"
  8112. static="false" final="false" visibility="public"
  8113. deprecated="not deprecated">
  8114. <param name="ignored" type="org.apache.hadoop.fs.FileSystem"/>
  8115. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  8116. <param name="name" type="java.lang.String"/>
  8117. <param name="progress" type="org.apache.hadoop.util.Progressable"/>
  8118. <exception name="IOException" type="java.io.IOException"/>
  8119. </method>
  8120. <method name="getReaders" return="org.apache.hadoop.io.SequenceFile.Reader[]"
  8121. abstract="false" native="false" synchronized="false"
  8122. static="true" final="false" visibility="public"
  8123. deprecated="not deprecated">
  8124. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  8125. <param name="dir" type="org.apache.hadoop.fs.Path"/>
  8126. <exception name="IOException" type="java.io.IOException"/>
  8127. <doc>
  8128. <![CDATA[Open the output generated by this format.]]>
  8129. </doc>
  8130. </method>
  8131. <method name="getOutputCompressionType" return="org.apache.hadoop.io.SequenceFile.CompressionType"
  8132. abstract="false" native="false" synchronized="false"
  8133. static="true" final="false" visibility="public"
  8134. deprecated="not deprecated">
  8135. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  8136. <doc>
  8137. <![CDATA[Get the {@link CompressionType} for the output {@link SequenceFile}.
  8138. @param conf the {@link JobConf}
  8139. @return the {@link CompressionType} for the output {@link SequenceFile},
  8140. defaulting to {@link CompressionType#RECORD}]]>
  8141. </doc>
  8142. </method>
  8143. <method name="setOutputCompressionType"
  8144. abstract="false" native="false" synchronized="false"
  8145. static="true" final="false" visibility="public"
  8146. deprecated="not deprecated">
  8147. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  8148. <param name="style" type="org.apache.hadoop.io.SequenceFile.CompressionType"/>
  8149. <doc>
  8150. <![CDATA[Set the {@link CompressionType} for the output {@link SequenceFile}.
  8151. @param conf the {@link JobConf} to modify
  8152. @param style the {@link CompressionType} for the output
  8153. {@link SequenceFile}]]>
  8154. </doc>
  8155. </method>
  8156. <doc>
  8157. <![CDATA[An {@link OutputFormat} that writes {@link SequenceFile}s.
  8158. @deprecated Use
  8159. {@link org.apache.hadoop.mapreduce.lib.output.SequenceFileOutputFormat}
  8160. instead.]]>
  8161. </doc>
  8162. </class>
  8163. <!-- end class org.apache.hadoop.mapred.SequenceFileOutputFormat -->
  8164. <!-- start class org.apache.hadoop.mapred.SequenceFileRecordReader -->
  8165. <class name="SequenceFileRecordReader" extends="java.lang.Object"
  8166. abstract="false"
  8167. static="false" final="false" visibility="public"
  8168. deprecated="not deprecated">
  8169. <implements name="org.apache.hadoop.mapred.RecordReader"/>
  8170. <constructor name="SequenceFileRecordReader" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.mapred.FileSplit"
  8171. static="false" final="false" visibility="public"
  8172. deprecated="not deprecated">
  8173. <exception name="IOException" type="java.io.IOException"/>
  8174. </constructor>
  8175. <method name="getKeyClass" return="java.lang.Class"
  8176. abstract="false" native="false" synchronized="false"
  8177. static="false" final="false" visibility="public"
  8178. deprecated="not deprecated">
  8179. <doc>
  8180. <![CDATA[The class of key that must be passed to {@link
  8181. #next(Object, Object)}..]]>
  8182. </doc>
  8183. </method>
  8184. <method name="getValueClass" return="java.lang.Class"
  8185. abstract="false" native="false" synchronized="false"
  8186. static="false" final="false" visibility="public"
  8187. deprecated="not deprecated">
  8188. <doc>
  8189. <![CDATA[The class of value that must be passed to {@link
  8190. #next(Object, Object)}..]]>
  8191. </doc>
  8192. </method>
  8193. <method name="createKey" return="java.lang.Object"
  8194. abstract="false" native="false" synchronized="false"
  8195. static="false" final="false" visibility="public"
  8196. deprecated="not deprecated">
  8197. </method>
  8198. <method name="createValue" return="java.lang.Object"
  8199. abstract="false" native="false" synchronized="false"
  8200. static="false" final="false" visibility="public"
  8201. deprecated="not deprecated">
  8202. </method>
  8203. <method name="next" return="boolean"
  8204. abstract="false" native="false" synchronized="true"
  8205. static="false" final="false" visibility="public"
  8206. deprecated="not deprecated">
  8207. <param name="key" type="java.lang.Object"/>
  8208. <param name="value" type="java.lang.Object"/>
  8209. <exception name="IOException" type="java.io.IOException"/>
  8210. </method>
  8211. <method name="next" return="boolean"
  8212. abstract="false" native="false" synchronized="true"
  8213. static="false" final="false" visibility="protected"
  8214. deprecated="not deprecated">
  8215. <param name="key" type="java.lang.Object"/>
  8216. <exception name="IOException" type="java.io.IOException"/>
  8217. </method>
  8218. <method name="getCurrentValue"
  8219. abstract="false" native="false" synchronized="true"
  8220. static="false" final="false" visibility="protected"
  8221. deprecated="not deprecated">
  8222. <param name="value" type="java.lang.Object"/>
  8223. <exception name="IOException" type="java.io.IOException"/>
  8224. </method>
  8225. <method name="getProgress" return="float"
  8226. abstract="false" native="false" synchronized="false"
  8227. static="false" final="false" visibility="public"
  8228. deprecated="not deprecated">
  8229. <exception name="IOException" type="java.io.IOException"/>
  8230. <doc>
  8231. <![CDATA[Return the progress within the input split
  8232. @return 0.0 to 1.0 of the input byte range]]>
  8233. </doc>
  8234. </method>
  8235. <method name="getPos" return="long"
  8236. abstract="false" native="false" synchronized="true"
  8237. static="false" final="false" visibility="public"
  8238. deprecated="not deprecated">
  8239. <exception name="IOException" type="java.io.IOException"/>
  8240. </method>
  8241. <method name="seek"
  8242. abstract="false" native="false" synchronized="true"
  8243. static="false" final="false" visibility="protected"
  8244. deprecated="not deprecated">
  8245. <param name="pos" type="long"/>
  8246. <exception name="IOException" type="java.io.IOException"/>
  8247. </method>
  8248. <method name="close"
  8249. abstract="false" native="false" synchronized="true"
  8250. static="false" final="false" visibility="public"
  8251. deprecated="not deprecated">
  8252. <exception name="IOException" type="java.io.IOException"/>
  8253. </method>
  8254. <field name="conf" type="org.apache.hadoop.conf.Configuration"
  8255. transient="false" volatile="false"
  8256. static="false" final="false" visibility="protected"
  8257. deprecated="not deprecated">
  8258. </field>
  8259. <doc>
  8260. <![CDATA[An {@link RecordReader} for {@link SequenceFile}s.]]>
  8261. </doc>
  8262. </class>
  8263. <!-- end class org.apache.hadoop.mapred.SequenceFileRecordReader -->
  8264. <!-- start class org.apache.hadoop.mapred.SkipBadRecords -->
  8265. <class name="SkipBadRecords" extends="java.lang.Object"
  8266. abstract="false"
  8267. static="false" final="false" visibility="public"
  8268. deprecated="not deprecated">
  8269. <constructor name="SkipBadRecords"
  8270. static="false" final="false" visibility="public"
  8271. deprecated="not deprecated">
  8272. </constructor>
  8273. <method name="getAttemptsToStartSkipping" return="int"
  8274. abstract="false" native="false" synchronized="false"
  8275. static="true" final="false" visibility="public"
  8276. deprecated="not deprecated">
  8277. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  8278. <doc>
  8279. <![CDATA[Get the number of Task attempts AFTER which skip mode
  8280. will be kicked off. When skip mode is kicked off, the
  8281. tasks reports the range of records which it will process
  8282. next to the TaskTracker. So that on failures, TT knows which
  8283. ones are possibly the bad records. On further executions,
  8284. those are skipped.
  8285. Default value is 2.
  8286. @param conf the configuration
  8287. @return attemptsToStartSkipping no of task attempts]]>
  8288. </doc>
  8289. </method>
  8290. <method name="setAttemptsToStartSkipping"
  8291. abstract="false" native="false" synchronized="false"
  8292. static="true" final="false" visibility="public"
  8293. deprecated="not deprecated">
  8294. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  8295. <param name="attemptsToStartSkipping" type="int"/>
  8296. <doc>
  8297. <![CDATA[Set the number of Task attempts AFTER which skip mode
  8298. will be kicked off. When skip mode is kicked off, the
  8299. tasks reports the range of records which it will process
  8300. next to the TaskTracker. So that on failures, TT knows which
  8301. ones are possibly the bad records. On further executions,
  8302. those are skipped.
  8303. Default value is 2.
  8304. @param conf the configuration
  8305. @param attemptsToStartSkipping no of task attempts]]>
  8306. </doc>
  8307. </method>
  8308. <method name="getAutoIncrMapperProcCount" return="boolean"
  8309. abstract="false" native="false" synchronized="false"
  8310. static="true" final="false" visibility="public"
  8311. deprecated="not deprecated">
  8312. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  8313. <doc>
  8314. <![CDATA[Get the flag which if set to true,
  8315. {@link SkipBadRecords#COUNTER_MAP_PROCESSED_RECORDS} is incremented
  8316. by MapRunner after invoking the map function. This value must be set to
  8317. false for applications which process the records asynchronously
  8318. or buffer the input records. For example streaming.
  8319. In such cases applications should increment this counter on their own.
  8320. Default value is true.
  8321. @param conf the configuration
  8322. @return <code>true</code> if auto increment
  8323. {@link SkipBadRecords#COUNTER_MAP_PROCESSED_RECORDS}.
  8324. <code>false</code> otherwise.]]>
  8325. </doc>
  8326. </method>
  8327. <method name="setAutoIncrMapperProcCount"
  8328. abstract="false" native="false" synchronized="false"
  8329. static="true" final="false" visibility="public"
  8330. deprecated="not deprecated">
  8331. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  8332. <param name="autoIncr" type="boolean"/>
  8333. <doc>
  8334. <![CDATA[Set the flag which if set to true,
  8335. {@link SkipBadRecords#COUNTER_MAP_PROCESSED_RECORDS} is incremented
  8336. by MapRunner after invoking the map function. This value must be set to
  8337. false for applications which process the records asynchronously
  8338. or buffer the input records. For example streaming.
  8339. In such cases applications should increment this counter on their own.
  8340. Default value is true.
  8341. @param conf the configuration
  8342. @param autoIncr whether to auto increment
  8343. {@link SkipBadRecords#COUNTER_MAP_PROCESSED_RECORDS}.]]>
  8344. </doc>
  8345. </method>
  8346. <method name="getAutoIncrReducerProcCount" return="boolean"
  8347. abstract="false" native="false" synchronized="false"
  8348. static="true" final="false" visibility="public"
  8349. deprecated="not deprecated">
  8350. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  8351. <doc>
  8352. <![CDATA[Get the flag which if set to true,
  8353. {@link SkipBadRecords#COUNTER_REDUCE_PROCESSED_GROUPS} is incremented
  8354. by framework after invoking the reduce function. This value must be set to
  8355. false for applications which process the records asynchronously
  8356. or buffer the input records. For example streaming.
  8357. In such cases applications should increment this counter on their own.
  8358. Default value is true.
  8359. @param conf the configuration
  8360. @return <code>true</code> if auto increment
  8361. {@link SkipBadRecords#COUNTER_REDUCE_PROCESSED_GROUPS}.
  8362. <code>false</code> otherwise.]]>
  8363. </doc>
  8364. </method>
  8365. <method name="setAutoIncrReducerProcCount"
  8366. abstract="false" native="false" synchronized="false"
  8367. static="true" final="false" visibility="public"
  8368. deprecated="not deprecated">
  8369. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  8370. <param name="autoIncr" type="boolean"/>
  8371. <doc>
  8372. <![CDATA[Set the flag which if set to true,
  8373. {@link SkipBadRecords#COUNTER_REDUCE_PROCESSED_GROUPS} is incremented
  8374. by framework after invoking the reduce function. This value must be set to
  8375. false for applications which process the records asynchronously
  8376. or buffer the input records. For example streaming.
  8377. In such cases applications should increment this counter on their own.
  8378. Default value is true.
  8379. @param conf the configuration
  8380. @param autoIncr whether to auto increment
  8381. {@link SkipBadRecords#COUNTER_REDUCE_PROCESSED_GROUPS}.]]>
  8382. </doc>
  8383. </method>
  8384. <method name="getSkipOutputPath" return="org.apache.hadoop.fs.Path"
  8385. abstract="false" native="false" synchronized="false"
  8386. static="true" final="false" visibility="public"
  8387. deprecated="not deprecated">
  8388. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  8389. <doc>
  8390. <![CDATA[Get the directory to which skipped records are written. By default it is
  8391. the sub directory of the output _logs directory.
  8392. User can stop writing skipped records by setting the value null.
  8393. @param conf the configuration.
  8394. @return path skip output directory. Null is returned if this is not set
  8395. and output directory is also not set.]]>
  8396. </doc>
  8397. </method>
  8398. <method name="setSkipOutputPath"
  8399. abstract="false" native="false" synchronized="false"
  8400. static="true" final="false" visibility="public"
  8401. deprecated="not deprecated">
  8402. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  8403. <param name="path" type="org.apache.hadoop.fs.Path"/>
  8404. <doc>
  8405. <![CDATA[Set the directory to which skipped records are written. By default it is
  8406. the sub directory of the output _logs directory.
  8407. User can stop writing skipped records by setting the value null.
  8408. @param conf the configuration.
  8409. @param path skip output directory path]]>
  8410. </doc>
  8411. </method>
  8412. <method name="getMapperMaxSkipRecords" return="long"
  8413. abstract="false" native="false" synchronized="false"
  8414. static="true" final="false" visibility="public"
  8415. deprecated="not deprecated">
  8416. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  8417. <doc>
  8418. <![CDATA[Get the number of acceptable skip records surrounding the bad record PER
  8419. bad record in mapper. The number includes the bad record as well.
  8420. To turn the feature of detection/skipping of bad records off, set the
  8421. value to 0.
  8422. The framework tries to narrow down the skipped range by retrying
  8423. until this threshold is met OR all attempts get exhausted for this task.
  8424. Set the value to Long.MAX_VALUE to indicate that framework need not try to
  8425. narrow down. Whatever records(depends on application) get skipped are
  8426. acceptable.
  8427. Default value is 0.
  8428. @param conf the configuration
  8429. @return maxSkipRecs acceptable skip records.]]>
  8430. </doc>
  8431. </method>
  8432. <method name="setMapperMaxSkipRecords"
  8433. abstract="false" native="false" synchronized="false"
  8434. static="true" final="false" visibility="public"
  8435. deprecated="not deprecated">
  8436. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  8437. <param name="maxSkipRecs" type="long"/>
  8438. <doc>
  8439. <![CDATA[Set the number of acceptable skip records surrounding the bad record PER
  8440. bad record in mapper. The number includes the bad record as well.
  8441. To turn the feature of detection/skipping of bad records off, set the
  8442. value to 0.
  8443. The framework tries to narrow down the skipped range by retrying
  8444. until this threshold is met OR all attempts get exhausted for this task.
  8445. Set the value to Long.MAX_VALUE to indicate that framework need not try to
  8446. narrow down. Whatever records(depends on application) get skipped are
  8447. acceptable.
  8448. Default value is 0.
  8449. @param conf the configuration
  8450. @param maxSkipRecs acceptable skip records.]]>
  8451. </doc>
  8452. </method>
  8453. <method name="getReducerMaxSkipGroups" return="long"
  8454. abstract="false" native="false" synchronized="false"
  8455. static="true" final="false" visibility="public"
  8456. deprecated="not deprecated">
  8457. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  8458. <doc>
  8459. <![CDATA[Get the number of acceptable skip groups surrounding the bad group PER
  8460. bad group in reducer. The number includes the bad group as well.
  8461. To turn the feature of detection/skipping of bad groups off, set the
  8462. value to 0.
  8463. The framework tries to narrow down the skipped range by retrying
  8464. until this threshold is met OR all attempts get exhausted for this task.
  8465. Set the value to Long.MAX_VALUE to indicate that framework need not try to
  8466. narrow down. Whatever groups(depends on application) get skipped are
  8467. acceptable.
  8468. Default value is 0.
  8469. @param conf the configuration
  8470. @return maxSkipGrps acceptable skip groups.]]>
  8471. </doc>
  8472. </method>
  8473. <method name="setReducerMaxSkipGroups"
  8474. abstract="false" native="false" synchronized="false"
  8475. static="true" final="false" visibility="public"
  8476. deprecated="not deprecated">
  8477. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  8478. <param name="maxSkipGrps" type="long"/>
  8479. <doc>
  8480. <![CDATA[Set the number of acceptable skip groups surrounding the bad group PER
  8481. bad group in reducer. The number includes the bad group as well.
  8482. To turn the feature of detection/skipping of bad groups off, set the
  8483. value to 0.
  8484. The framework tries to narrow down the skipped range by retrying
  8485. until this threshold is met OR all attempts get exhausted for this task.
  8486. Set the value to Long.MAX_VALUE to indicate that framework need not try to
  8487. narrow down. Whatever groups(depends on application) get skipped are
  8488. acceptable.
  8489. Default value is 0.
  8490. @param conf the configuration
  8491. @param maxSkipGrps acceptable skip groups.]]>
  8492. </doc>
  8493. </method>
  8494. <field name="COUNTER_GROUP" type="java.lang.String"
  8495. transient="false" volatile="false"
  8496. static="true" final="true" visibility="public"
  8497. deprecated="not deprecated">
  8498. <doc>
  8499. <![CDATA[Special counters which are written by the application and are
  8500. used by the framework for detecting bad records. For detecting bad records
  8501. these counters must be incremented by the application.]]>
  8502. </doc>
  8503. </field>
  8504. <field name="COUNTER_MAP_PROCESSED_RECORDS" type="java.lang.String"
  8505. transient="false" volatile="false"
  8506. static="true" final="true" visibility="public"
  8507. deprecated="not deprecated">
  8508. <doc>
  8509. <![CDATA[Number of processed map records.
  8510. @see SkipBadRecords#getAutoIncrMapperProcCount(Configuration)]]>
  8511. </doc>
  8512. </field>
  8513. <field name="COUNTER_REDUCE_PROCESSED_GROUPS" type="java.lang.String"
  8514. transient="false" volatile="false"
  8515. static="true" final="true" visibility="public"
  8516. deprecated="not deprecated">
  8517. <doc>
  8518. <![CDATA[Number of processed reduce groups.
  8519. @see SkipBadRecords#getAutoIncrReducerProcCount(Configuration)]]>
  8520. </doc>
  8521. </field>
  8522. <doc>
  8523. <![CDATA[Utility class for skip bad records functionality. It contains various
  8524. settings related to skipping of bad records.
  8525. <p>Hadoop provides an optional mode of execution in which the bad records
  8526. are detected and skipped in further attempts.
  8527. <p>This feature can be used when map/reduce tasks crashes deterministically on
  8528. certain input. This happens due to bugs in the map/reduce function. The usual
  8529. course would be to fix these bugs. But sometimes this is not possible;
  8530. perhaps the bug is in third party libraries for which the source code is
  8531. not available. Due to this, the task never reaches to completion even with
  8532. multiple attempts and complete data for that task is lost.</p>
  8533. <p>With this feature, only a small portion of data is lost surrounding
  8534. the bad record, which may be acceptable for some user applications.
  8535. see {@link SkipBadRecords#setMapperMaxSkipRecords(Configuration, long)}</p>
  8536. <p>The skipping mode gets kicked off after certain no of failures
  8537. see {@link SkipBadRecords#setAttemptsToStartSkipping(Configuration, int)}</p>
  8538. <p>In the skipping mode, the map/reduce task maintains the record range which
  8539. is getting processed at all times. Before giving the input to the
  8540. map/reduce function, it sends this record range to the Task tracker.
  8541. If task crashes, the Task tracker knows which one was the last reported
  8542. range. On further attempts that range get skipped.</p>]]>
  8543. </doc>
  8544. </class>
  8545. <!-- end class org.apache.hadoop.mapred.SkipBadRecords -->
  8546. <!-- start class org.apache.hadoop.mapred.TaskAttemptContext -->
  8547. <class name="TaskAttemptContext" extends="org.apache.hadoop.mapreduce.TaskAttemptContext"
  8548. abstract="false"
  8549. static="false" final="false" visibility="public"
  8550. deprecated="Use {@link org.apache.hadoop.mapreduce.TaskAttemptContext}
  8551. instead.">
  8552. <method name="getTaskAttemptID" return="org.apache.hadoop.mapred.TaskAttemptID"
  8553. abstract="false" native="false" synchronized="false"
  8554. static="false" final="false" visibility="public"
  8555. deprecated="not deprecated">
  8556. <doc>
  8557. <![CDATA[Get the taskAttemptID.
  8558. @return TaskAttemptID]]>
  8559. </doc>
  8560. </method>
  8561. <method name="getProgressible" return="org.apache.hadoop.util.Progressable"
  8562. abstract="false" native="false" synchronized="false"
  8563. static="false" final="false" visibility="public"
  8564. deprecated="not deprecated">
  8565. </method>
  8566. <method name="getJobConf" return="org.apache.hadoop.mapred.JobConf"
  8567. abstract="false" native="false" synchronized="false"
  8568. static="false" final="false" visibility="public"
  8569. deprecated="not deprecated">
  8570. </method>
  8571. <method name="progress"
  8572. abstract="false" native="false" synchronized="false"
  8573. static="false" final="false" visibility="public"
  8574. deprecated="not deprecated">
  8575. </method>
  8576. <doc>
  8577. <![CDATA[@deprecated Use {@link org.apache.hadoop.mapreduce.TaskAttemptContext}
  8578. instead.]]>
  8579. </doc>
  8580. </class>
  8581. <!-- end class org.apache.hadoop.mapred.TaskAttemptContext -->
  8582. <!-- start class org.apache.hadoop.mapred.TaskAttemptID -->
  8583. <class name="TaskAttemptID" extends="org.apache.hadoop.mapreduce.TaskAttemptID"
  8584. abstract="false"
  8585. static="false" final="false" visibility="public"
  8586. deprecated="not deprecated">
  8587. <constructor name="TaskAttemptID" type="org.apache.hadoop.mapred.TaskID, int"
  8588. static="false" final="false" visibility="public"
  8589. deprecated="not deprecated">
  8590. <doc>
  8591. <![CDATA[Constructs a TaskAttemptID object from given {@link TaskID}.
  8592. @param taskId TaskID that this task belongs to
  8593. @param id the task attempt number]]>
  8594. </doc>
  8595. </constructor>
  8596. <constructor name="TaskAttemptID" type="java.lang.String, int, boolean, int, int"
  8597. static="false" final="false" visibility="public"
  8598. deprecated="not deprecated">
  8599. <doc>
  8600. <![CDATA[Constructs a TaskId object from given parts.
  8601. @param jtIdentifier jobTracker identifier
  8602. @param jobId job number
  8603. @param isMap whether the tip is a map
  8604. @param taskId taskId number
  8605. @param id the task attempt number]]>
  8606. </doc>
  8607. </constructor>
  8608. <constructor name="TaskAttemptID"
  8609. static="false" final="false" visibility="public"
  8610. deprecated="not deprecated">
  8611. </constructor>
  8612. <method name="downgrade" return="org.apache.hadoop.mapred.TaskAttemptID"
  8613. abstract="false" native="false" synchronized="false"
  8614. static="true" final="false" visibility="public"
  8615. deprecated="not deprecated">
  8616. <param name="old" type="org.apache.hadoop.mapreduce.TaskAttemptID"/>
  8617. <doc>
  8618. <![CDATA[Downgrade a new TaskAttemptID to an old one
  8619. @param old the new id
  8620. @return either old or a new TaskAttemptID constructed to match old]]>
  8621. </doc>
  8622. </method>
  8623. <method name="getTaskID" return="org.apache.hadoop.mapred.TaskID"
  8624. abstract="false" native="false" synchronized="false"
  8625. static="false" final="false" visibility="public"
  8626. deprecated="not deprecated">
  8627. </method>
  8628. <method name="getJobID" return="org.apache.hadoop.mapred.JobID"
  8629. abstract="false" native="false" synchronized="false"
  8630. static="false" final="false" visibility="public"
  8631. deprecated="not deprecated">
  8632. </method>
  8633. <method name="read" return="org.apache.hadoop.mapred.TaskAttemptID"
  8634. abstract="false" native="false" synchronized="false"
  8635. static="true" final="false" visibility="public"
  8636. deprecated="not deprecated">
  8637. <param name="in" type="java.io.DataInput"/>
  8638. <exception name="IOException" type="java.io.IOException"/>
  8639. </method>
  8640. <method name="forName" return="org.apache.hadoop.mapred.TaskAttemptID"
  8641. abstract="false" native="false" synchronized="false"
  8642. static="true" final="false" visibility="public"
  8643. deprecated="not deprecated">
  8644. <param name="str" type="java.lang.String"/>
  8645. <exception name="IllegalArgumentException" type="java.lang.IllegalArgumentException"/>
  8646. <doc>
  8647. <![CDATA[Construct a TaskAttemptID object from given string
  8648. @return constructed TaskAttemptID object or null if the given String is null
  8649. @throws IllegalArgumentException if the given string is malformed]]>
  8650. </doc>
  8651. </method>
  8652. <method name="getTaskAttemptIDsPattern" return="java.lang.String"
  8653. abstract="false" native="false" synchronized="false"
  8654. static="true" final="false" visibility="public"
  8655. deprecated="not deprecated">
  8656. <param name="jtIdentifier" type="java.lang.String"/>
  8657. <param name="jobId" type="java.lang.Integer"/>
  8658. <param name="isMap" type="java.lang.Boolean"/>
  8659. <param name="taskId" type="java.lang.Integer"/>
  8660. <param name="attemptId" type="java.lang.Integer"/>
  8661. <doc>
  8662. <![CDATA[Returns a regex pattern which matches task attempt IDs. Arguments can
  8663. be given null, in which case that part of the regex will be generic.
  8664. For example to obtain a regex matching <i>all task attempt IDs</i>
  8665. of <i>any jobtracker</i>, in <i>any job</i>, of the <i>first
  8666. map task</i>, we would use :
  8667. <pre>
  8668. TaskAttemptID.getTaskAttemptIDsPattern(null, null, true, 1, null);
  8669. </pre>
  8670. which will return :
  8671. <pre> "attempt_[^_]*_[0-9]*_m_000001_[0-9]*" </pre>
  8672. @param jtIdentifier jobTracker identifier, or null
  8673. @param jobId job number, or null
  8674. @param isMap whether the tip is a map, or null
  8675. @param taskId taskId number, or null
  8676. @param attemptId the task attempt number, or null
  8677. @return a regex pattern matching TaskAttemptIDs]]>
  8678. </doc>
  8679. </method>
  8680. <doc>
  8681. <![CDATA[TaskAttemptID represents the immutable and unique identifier for
  8682. a task attempt. Each task attempt is one particular instance of a Map or
  8683. Reduce Task identified by its TaskID.
  8684. TaskAttemptID consists of 2 parts. First part is the
  8685. {@link TaskID}, that this TaskAttemptID belongs to.
  8686. Second part is the task attempt number. <br>
  8687. An example TaskAttemptID is :
  8688. <code>attempt_200707121733_0003_m_000005_0</code> , which represents the
  8689. zeroth task attempt for the fifth map task in the third job
  8690. running at the jobtracker started at <code>200707121733</code>.
  8691. <p>
  8692. Applications should never construct or parse TaskAttemptID strings
  8693. , but rather use appropriate constructors or {@link #forName(String)}
  8694. method.
  8695. @see JobID
  8696. @see TaskID]]>
  8697. </doc>
  8698. </class>
  8699. <!-- end class org.apache.hadoop.mapred.TaskAttemptID -->
  8700. <!-- start class org.apache.hadoop.mapred.TaskCompletionEvent -->
  8701. <class name="TaskCompletionEvent" extends="java.lang.Object"
  8702. abstract="false"
  8703. static="false" final="false" visibility="public"
  8704. deprecated="not deprecated">
  8705. <implements name="org.apache.hadoop.io.Writable"/>
  8706. <constructor name="TaskCompletionEvent"
  8707. static="false" final="false" visibility="public"
  8708. deprecated="not deprecated">
  8709. <doc>
  8710. <![CDATA[Default constructor for Writable.]]>
  8711. </doc>
  8712. </constructor>
  8713. <constructor name="TaskCompletionEvent" type="int, org.apache.hadoop.mapred.TaskAttemptID, int, boolean, org.apache.hadoop.mapred.TaskCompletionEvent.Status, java.lang.String"
  8714. static="false" final="false" visibility="public"
  8715. deprecated="not deprecated">
  8716. <doc>
  8717. <![CDATA[Constructor. eventId should be created externally and incremented
  8718. per event for each job.
  8719. @param eventId event id, event id should be unique and assigned in
  8720. incrementally, starting from 0.
  8721. @param taskId task id
  8722. @param status task's status
  8723. @param taskTrackerHttp task tracker's host:port for http.]]>
  8724. </doc>
  8725. </constructor>
  8726. <method name="getEventId" return="int"
  8727. abstract="false" native="false" synchronized="false"
  8728. static="false" final="false" visibility="public"
  8729. deprecated="not deprecated">
  8730. <doc>
  8731. <![CDATA[Returns event Id.
  8732. @return event id]]>
  8733. </doc>
  8734. </method>
  8735. <method name="getTaskId" return="java.lang.String"
  8736. abstract="false" native="false" synchronized="false"
  8737. static="false" final="false" visibility="public"
  8738. deprecated="use {@link #getTaskAttemptId()} instead.">
  8739. <doc>
  8740. <![CDATA[Returns task id.
  8741. @return task id
  8742. @deprecated use {@link #getTaskAttemptId()} instead.]]>
  8743. </doc>
  8744. </method>
  8745. <method name="getTaskAttemptId" return="org.apache.hadoop.mapred.TaskAttemptID"
  8746. abstract="false" native="false" synchronized="false"
  8747. static="false" final="false" visibility="public"
  8748. deprecated="not deprecated">
  8749. <doc>
  8750. <![CDATA[Returns task id.
  8751. @return task id]]>
  8752. </doc>
  8753. </method>
  8754. <method name="getTaskStatus" return="org.apache.hadoop.mapred.TaskCompletionEvent.Status"
  8755. abstract="false" native="false" synchronized="false"
  8756. static="false" final="false" visibility="public"
  8757. deprecated="not deprecated">
  8758. <doc>
  8759. <![CDATA[Returns enum Status.SUCESS or Status.FAILURE.
  8760. @return task tracker status]]>
  8761. </doc>
  8762. </method>
  8763. <method name="getTaskTrackerHttp" return="java.lang.String"
  8764. abstract="false" native="false" synchronized="false"
  8765. static="false" final="false" visibility="public"
  8766. deprecated="not deprecated">
  8767. <doc>
  8768. <![CDATA[http location of the tasktracker where this task ran.
  8769. @return http location of tasktracker user logs]]>
  8770. </doc>
  8771. </method>
  8772. <method name="getTaskRunTime" return="int"
  8773. abstract="false" native="false" synchronized="false"
  8774. static="false" final="false" visibility="public"
  8775. deprecated="not deprecated">
  8776. <doc>
  8777. <![CDATA[Returns time (in millisec) the task took to complete.]]>
  8778. </doc>
  8779. </method>
  8780. <method name="setTaskRunTime"
  8781. abstract="false" native="false" synchronized="false"
  8782. static="false" final="false" visibility="public"
  8783. deprecated="not deprecated">
  8784. <param name="taskCompletionTime" type="int"/>
  8785. <doc>
  8786. <![CDATA[Set the task completion time
  8787. @param taskCompletionTime time (in millisec) the task took to complete]]>
  8788. </doc>
  8789. </method>
  8790. <method name="setEventId"
  8791. abstract="false" native="false" synchronized="false"
  8792. static="false" final="false" visibility="public"
  8793. deprecated="not deprecated">
  8794. <param name="eventId" type="int"/>
  8795. <doc>
  8796. <![CDATA[set event Id. should be assigned incrementally starting from 0.
  8797. @param eventId]]>
  8798. </doc>
  8799. </method>
  8800. <method name="setTaskId"
  8801. abstract="false" native="false" synchronized="false"
  8802. static="false" final="false" visibility="public"
  8803. deprecated="use {@link #setTaskID(TaskAttemptID)} instead.">
  8804. <param name="taskId" type="java.lang.String"/>
  8805. <doc>
  8806. <![CDATA[Sets task id.
  8807. @param taskId
  8808. @deprecated use {@link #setTaskID(TaskAttemptID)} instead.]]>
  8809. </doc>
  8810. </method>
  8811. <method name="setTaskID"
  8812. abstract="false" native="false" synchronized="false"
  8813. static="false" final="false" visibility="public"
  8814. deprecated="not deprecated">
  8815. <param name="taskId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  8816. <doc>
  8817. <![CDATA[Sets task id.
  8818. @param taskId]]>
  8819. </doc>
  8820. </method>
  8821. <method name="setTaskStatus"
  8822. abstract="false" native="false" synchronized="false"
  8823. static="false" final="false" visibility="public"
  8824. deprecated="not deprecated">
  8825. <param name="status" type="org.apache.hadoop.mapred.TaskCompletionEvent.Status"/>
  8826. <doc>
  8827. <![CDATA[Set task status.
  8828. @param status]]>
  8829. </doc>
  8830. </method>
  8831. <method name="setTaskTrackerHttp"
  8832. abstract="false" native="false" synchronized="false"
  8833. static="false" final="false" visibility="public"
  8834. deprecated="not deprecated">
  8835. <param name="taskTrackerHttp" type="java.lang.String"/>
  8836. <doc>
  8837. <![CDATA[Set task tracker http location.
  8838. @param taskTrackerHttp]]>
  8839. </doc>
  8840. </method>
  8841. <method name="toString" return="java.lang.String"
  8842. abstract="false" native="false" synchronized="false"
  8843. static="false" final="false" visibility="public"
  8844. deprecated="not deprecated">
  8845. </method>
  8846. <method name="equals" return="boolean"
  8847. abstract="false" native="false" synchronized="false"
  8848. static="false" final="false" visibility="public"
  8849. deprecated="not deprecated">
  8850. <param name="o" type="java.lang.Object"/>
  8851. </method>
  8852. <method name="hashCode" return="int"
  8853. abstract="false" native="false" synchronized="false"
  8854. static="false" final="false" visibility="public"
  8855. deprecated="not deprecated">
  8856. </method>
  8857. <method name="isMapTask" return="boolean"
  8858. abstract="false" native="false" synchronized="false"
  8859. static="false" final="false" visibility="public"
  8860. deprecated="not deprecated">
  8861. </method>
  8862. <method name="idWithinJob" return="int"
  8863. abstract="false" native="false" synchronized="false"
  8864. static="false" final="false" visibility="public"
  8865. deprecated="not deprecated">
  8866. </method>
  8867. <method name="write"
  8868. abstract="false" native="false" synchronized="false"
  8869. static="false" final="false" visibility="public"
  8870. deprecated="not deprecated">
  8871. <param name="out" type="java.io.DataOutput"/>
  8872. <exception name="IOException" type="java.io.IOException"/>
  8873. </method>
  8874. <method name="readFields"
  8875. abstract="false" native="false" synchronized="false"
  8876. static="false" final="false" visibility="public"
  8877. deprecated="not deprecated">
  8878. <param name="in" type="java.io.DataInput"/>
  8879. <exception name="IOException" type="java.io.IOException"/>
  8880. </method>
  8881. <field name="EMPTY_ARRAY" type="org.apache.hadoop.mapred.TaskCompletionEvent[]"
  8882. transient="false" volatile="false"
  8883. static="true" final="true" visibility="public"
  8884. deprecated="not deprecated">
  8885. </field>
  8886. <doc>
  8887. <![CDATA[This is used to track task completion events on
  8888. job tracker.]]>
  8889. </doc>
  8890. </class>
  8891. <!-- end class org.apache.hadoop.mapred.TaskCompletionEvent -->
  8892. <!-- start class org.apache.hadoop.mapred.TaskCompletionEvent.Status -->
  8893. <class name="TaskCompletionEvent.Status" extends="java.lang.Enum"
  8894. abstract="false"
  8895. static="true" final="true" visibility="public"
  8896. deprecated="not deprecated">
  8897. <method name="values" return="org.apache.hadoop.mapred.TaskCompletionEvent.Status[]"
  8898. abstract="false" native="false" synchronized="false"
  8899. static="true" final="false" visibility="public"
  8900. deprecated="not deprecated">
  8901. </method>
  8902. <method name="valueOf" return="org.apache.hadoop.mapred.TaskCompletionEvent.Status"
  8903. abstract="false" native="false" synchronized="false"
  8904. static="true" final="false" visibility="public"
  8905. deprecated="not deprecated">
  8906. <param name="name" type="java.lang.String"/>
  8907. </method>
  8908. <field name="FAILED" type="org.apache.hadoop.mapred.TaskCompletionEvent.Status"
  8909. transient="false" volatile="false"
  8910. static="true" final="true" visibility="public"
  8911. deprecated="not deprecated">
  8912. </field>
  8913. <field name="KILLED" type="org.apache.hadoop.mapred.TaskCompletionEvent.Status"
  8914. transient="false" volatile="false"
  8915. static="true" final="true" visibility="public"
  8916. deprecated="not deprecated">
  8917. </field>
  8918. <field name="SUCCEEDED" type="org.apache.hadoop.mapred.TaskCompletionEvent.Status"
  8919. transient="false" volatile="false"
  8920. static="true" final="true" visibility="public"
  8921. deprecated="not deprecated">
  8922. </field>
  8923. <field name="OBSOLETE" type="org.apache.hadoop.mapred.TaskCompletionEvent.Status"
  8924. transient="false" volatile="false"
  8925. static="true" final="true" visibility="public"
  8926. deprecated="not deprecated">
  8927. </field>
  8928. <field name="TIPFAILED" type="org.apache.hadoop.mapred.TaskCompletionEvent.Status"
  8929. transient="false" volatile="false"
  8930. static="true" final="true" visibility="public"
  8931. deprecated="not deprecated">
  8932. </field>
  8933. </class>
  8934. <!-- end class org.apache.hadoop.mapred.TaskCompletionEvent.Status -->
  8935. <!-- start class org.apache.hadoop.mapred.TaskGraphServlet -->
  8936. <class name="TaskGraphServlet" extends="javax.servlet.http.HttpServlet"
  8937. abstract="false"
  8938. static="false" final="false" visibility="public"
  8939. deprecated="not deprecated">
  8940. <constructor name="TaskGraphServlet"
  8941. static="false" final="false" visibility="public"
  8942. deprecated="not deprecated">
  8943. </constructor>
  8944. <method name="doGet"
  8945. abstract="false" native="false" synchronized="false"
  8946. static="false" final="false" visibility="public"
  8947. deprecated="not deprecated">
  8948. <param name="request" type="javax.servlet.http.HttpServletRequest"/>
  8949. <param name="response" type="javax.servlet.http.HttpServletResponse"/>
  8950. <exception name="ServletException" type="javax.servlet.ServletException"/>
  8951. <exception name="IOException" type="java.io.IOException"/>
  8952. </method>
  8953. <field name="width" type="int"
  8954. transient="false" volatile="false"
  8955. static="true" final="true" visibility="public"
  8956. deprecated="not deprecated">
  8957. <doc>
  8958. <![CDATA[height of the graph w/o margins]]>
  8959. </doc>
  8960. </field>
  8961. <field name="height" type="int"
  8962. transient="false" volatile="false"
  8963. static="true" final="true" visibility="public"
  8964. deprecated="not deprecated">
  8965. <doc>
  8966. <![CDATA[height of the graph w/o margins]]>
  8967. </doc>
  8968. </field>
  8969. <field name="ymargin" type="int"
  8970. transient="false" volatile="false"
  8971. static="true" final="true" visibility="public"
  8972. deprecated="not deprecated">
  8973. <doc>
  8974. <![CDATA[margin space on y axis]]>
  8975. </doc>
  8976. </field>
  8977. <field name="xmargin" type="int"
  8978. transient="false" volatile="false"
  8979. static="true" final="true" visibility="public"
  8980. deprecated="not deprecated">
  8981. <doc>
  8982. <![CDATA[margin space on x axis]]>
  8983. </doc>
  8984. </field>
  8985. <doc>
  8986. <![CDATA[The servlet that outputs svg graphics for map / reduce task
  8987. statuses]]>
  8988. </doc>
  8989. </class>
  8990. <!-- end class org.apache.hadoop.mapred.TaskGraphServlet -->
  8991. <!-- start class org.apache.hadoop.mapred.TaskID -->
  8992. <class name="TaskID" extends="org.apache.hadoop.mapreduce.TaskID"
  8993. abstract="false"
  8994. static="false" final="false" visibility="public"
  8995. deprecated="not deprecated">
  8996. <constructor name="TaskID" type="org.apache.hadoop.mapreduce.JobID, boolean, int"
  8997. static="false" final="false" visibility="public"
  8998. deprecated="not deprecated">
  8999. <doc>
  9000. <![CDATA[Constructs a TaskID object from given {@link JobID}.
  9001. @param jobId JobID that this tip belongs to
  9002. @param isMap whether the tip is a map
  9003. @param id the tip number]]>
  9004. </doc>
  9005. </constructor>
  9006. <constructor name="TaskID" type="java.lang.String, int, boolean, int"
  9007. static="false" final="false" visibility="public"
  9008. deprecated="not deprecated">
  9009. <doc>
  9010. <![CDATA[Constructs a TaskInProgressId object from given parts.
  9011. @param jtIdentifier jobTracker identifier
  9012. @param jobId job number
  9013. @param isMap whether the tip is a map
  9014. @param id the tip number]]>
  9015. </doc>
  9016. </constructor>
  9017. <constructor name="TaskID"
  9018. static="false" final="false" visibility="public"
  9019. deprecated="not deprecated">
  9020. </constructor>
  9021. <method name="downgrade" return="org.apache.hadoop.mapred.TaskID"
  9022. abstract="false" native="false" synchronized="false"
  9023. static="true" final="false" visibility="public"
  9024. deprecated="not deprecated">
  9025. <param name="old" type="org.apache.hadoop.mapreduce.TaskID"/>
  9026. <doc>
  9027. <![CDATA[Downgrade a new TaskID to an old one
  9028. @param old a new or old TaskID
  9029. @return either old or a new TaskID build to match old]]>
  9030. </doc>
  9031. </method>
  9032. <method name="read" return="org.apache.hadoop.mapred.TaskID"
  9033. abstract="false" native="false" synchronized="false"
  9034. static="true" final="false" visibility="public"
  9035. deprecated="not deprecated">
  9036. <param name="in" type="java.io.DataInput"/>
  9037. <exception name="IOException" type="java.io.IOException"/>
  9038. </method>
  9039. <method name="getJobID" return="org.apache.hadoop.mapred.JobID"
  9040. abstract="false" native="false" synchronized="false"
  9041. static="false" final="false" visibility="public"
  9042. deprecated="not deprecated">
  9043. </method>
  9044. <method name="getTaskIDsPattern" return="java.lang.String"
  9045. abstract="false" native="false" synchronized="false"
  9046. static="true" final="false" visibility="public"
  9047. deprecated="not deprecated">
  9048. <param name="jtIdentifier" type="java.lang.String"/>
  9049. <param name="jobId" type="java.lang.Integer"/>
  9050. <param name="isMap" type="java.lang.Boolean"/>
  9051. <param name="taskId" type="java.lang.Integer"/>
  9052. <doc>
  9053. <![CDATA[Returns a regex pattern which matches task IDs. Arguments can
  9054. be given null, in which case that part of the regex will be generic.
  9055. For example to obtain a regex matching <i>the first map task</i>
  9056. of <i>any jobtracker</i>, of <i>any job</i>, we would use :
  9057. <pre>
  9058. TaskID.getTaskIDsPattern(null, null, true, 1);
  9059. </pre>
  9060. which will return :
  9061. <pre> "task_[^_]*_[0-9]*_m_000001*" </pre>
  9062. @param jtIdentifier jobTracker identifier, or null
  9063. @param jobId job number, or null
  9064. @param isMap whether the tip is a map, or null
  9065. @param taskId taskId number, or null
  9066. @return a regex pattern matching TaskIDs]]>
  9067. </doc>
  9068. </method>
  9069. <method name="forName" return="org.apache.hadoop.mapred.TaskID"
  9070. abstract="false" native="false" synchronized="false"
  9071. static="true" final="false" visibility="public"
  9072. deprecated="not deprecated">
  9073. <param name="str" type="java.lang.String"/>
  9074. <exception name="IllegalArgumentException" type="java.lang.IllegalArgumentException"/>
  9075. </method>
  9076. <doc>
  9077. <![CDATA[TaskID represents the immutable and unique identifier for
  9078. a Map or Reduce Task. Each TaskID encompasses multiple attempts made to
  9079. execute the Map or Reduce Task, each of which are uniquely indentified by
  9080. their TaskAttemptID.
  9081. TaskID consists of 3 parts. First part is the {@link JobID}, that this
  9082. TaskInProgress belongs to. Second part of the TaskID is either 'm' or 'r'
  9083. representing whether the task is a map task or a reduce task.
  9084. And the third part is the task number. <br>
  9085. An example TaskID is :
  9086. <code>task_200707121733_0003_m_000005</code> , which represents the
  9087. fifth map task in the third job running at the jobtracker
  9088. started at <code>200707121733</code>.
  9089. <p>
  9090. Applications should never construct or parse TaskID strings
  9091. , but rather use appropriate constructors or {@link #forName(String)}
  9092. method.
  9093. @see JobID
  9094. @see TaskAttemptID]]>
  9095. </doc>
  9096. </class>
  9097. <!-- end class org.apache.hadoop.mapred.TaskID -->
  9098. <!-- start class org.apache.hadoop.mapred.TaskLog -->
  9099. <class name="TaskLog" extends="java.lang.Object"
  9100. abstract="false"
  9101. static="false" final="false" visibility="public"
  9102. deprecated="not deprecated">
  9103. <constructor name="TaskLog"
  9104. static="false" final="false" visibility="public"
  9105. deprecated="not deprecated">
  9106. </constructor>
  9107. <method name="getTaskLogFile" return="java.io.File"
  9108. abstract="false" native="false" synchronized="false"
  9109. static="true" final="false" visibility="public"
  9110. deprecated="not deprecated">
  9111. <param name="taskid" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  9112. <param name="filter" type="org.apache.hadoop.mapred.TaskLog.LogName"/>
  9113. </method>
  9114. <method name="getRealTaskLogFileLocation" return="java.io.File"
  9115. abstract="false" native="false" synchronized="false"
  9116. static="true" final="false" visibility="public"
  9117. deprecated="not deprecated">
  9118. <param name="taskid" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  9119. <param name="filter" type="org.apache.hadoop.mapred.TaskLog.LogName"/>
  9120. </method>
  9121. <method name="getIndexFile" return="java.io.File"
  9122. abstract="false" native="false" synchronized="false"
  9123. static="true" final="false" visibility="public"
  9124. deprecated="not deprecated">
  9125. <param name="taskid" type="java.lang.String"/>
  9126. </method>
  9127. <method name="getIndexFile" return="java.io.File"
  9128. abstract="false" native="false" synchronized="false"
  9129. static="true" final="false" visibility="public"
  9130. deprecated="not deprecated">
  9131. <param name="taskid" type="java.lang.String"/>
  9132. <param name="isCleanup" type="boolean"/>
  9133. </method>
  9134. <method name="syncLogs"
  9135. abstract="false" native="false" synchronized="true"
  9136. static="true" final="false" visibility="public"
  9137. deprecated="not deprecated">
  9138. <param name="firstTaskid" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  9139. <param name="taskid" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  9140. <exception name="IOException" type="java.io.IOException"/>
  9141. </method>
  9142. <method name="syncLogs"
  9143. abstract="false" native="false" synchronized="true"
  9144. static="true" final="false" visibility="public"
  9145. deprecated="not deprecated">
  9146. <param name="firstTaskid" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  9147. <param name="taskid" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  9148. <param name="isCleanup" type="boolean"/>
  9149. <exception name="IOException" type="java.io.IOException"/>
  9150. </method>
  9151. <method name="cleanup"
  9152. abstract="false" native="false" synchronized="true"
  9153. static="true" final="false" visibility="public"
  9154. deprecated="not deprecated">
  9155. <param name="logsRetainHours" type="int"/>
  9156. <exception name="IOException" type="java.io.IOException"/>
  9157. <doc>
  9158. <![CDATA[Purge old user logs.
  9159. @throws IOException]]>
  9160. </doc>
  9161. </method>
  9162. <method name="getTaskLogLength" return="long"
  9163. abstract="false" native="false" synchronized="false"
  9164. static="true" final="false" visibility="public"
  9165. deprecated="not deprecated">
  9166. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  9167. <doc>
  9168. <![CDATA[Get the desired maximum length of task's logs.
  9169. @param conf the job to look in
  9170. @return the number of bytes to cap the log files at]]>
  9171. </doc>
  9172. </method>
  9173. <method name="captureOutAndError" return="java.util.List"
  9174. abstract="false" native="false" synchronized="false"
  9175. static="true" final="false" visibility="public"
  9176. deprecated="not deprecated">
  9177. <param name="cmd" type="java.util.List"/>
  9178. <param name="stdoutFilename" type="java.io.File"/>
  9179. <param name="stderrFilename" type="java.io.File"/>
  9180. <param name="tailLength" type="long"/>
  9181. <exception name="IOException" type="java.io.IOException"/>
  9182. <doc>
  9183. <![CDATA[Wrap a command in a shell to capture stdout and stderr to files.
  9184. If the tailLength is 0, the entire output will be saved.
  9185. @param cmd The command and the arguments that should be run
  9186. @param stdoutFilename The filename that stdout should be saved to
  9187. @param stderrFilename The filename that stderr should be saved to
  9188. @param tailLength The length of the tail to be saved.
  9189. @return the modified command that should be run]]>
  9190. </doc>
  9191. </method>
  9192. <method name="captureOutAndError" return="java.util.List"
  9193. abstract="false" native="false" synchronized="false"
  9194. static="true" final="false" visibility="public"
  9195. deprecated="not deprecated">
  9196. <param name="setup" type="java.util.List"/>
  9197. <param name="cmd" type="java.util.List"/>
  9198. <param name="stdoutFilename" type="java.io.File"/>
  9199. <param name="stderrFilename" type="java.io.File"/>
  9200. <param name="tailLength" type="long"/>
  9201. <exception name="IOException" type="java.io.IOException"/>
  9202. <doc>
  9203. <![CDATA[Wrap a command in a shell to capture stdout and stderr to files.
  9204. Setup commands such as setting memory limit can be passed which
  9205. will be executed before exec.
  9206. If the tailLength is 0, the entire output will be saved.
  9207. @param setup The setup commands for the execed process.
  9208. @param cmd The command and the arguments that should be run
  9209. @param stdoutFilename The filename that stdout should be saved to
  9210. @param stderrFilename The filename that stderr should be saved to
  9211. @param tailLength The length of the tail to be saved.
  9212. @return the modified command that should be run]]>
  9213. </doc>
  9214. </method>
  9215. <method name="captureOutAndError" return="java.util.List"
  9216. abstract="false" native="false" synchronized="false"
  9217. static="true" final="false" visibility="public"
  9218. deprecated="not deprecated">
  9219. <param name="setup" type="java.util.List"/>
  9220. <param name="cmd" type="java.util.List"/>
  9221. <param name="stdoutFilename" type="java.io.File"/>
  9222. <param name="stderrFilename" type="java.io.File"/>
  9223. <param name="tailLength" type="long"/>
  9224. <param name="pidFileName" type="java.lang.String"/>
  9225. <exception name="IOException" type="java.io.IOException"/>
  9226. <doc>
  9227. <![CDATA[Wrap a command in a shell to capture stdout and stderr to files.
  9228. Setup commands such as setting memory limit can be passed which
  9229. will be executed before exec.
  9230. If the tailLength is 0, the entire output will be saved.
  9231. @param setup The setup commands for the execed process.
  9232. @param cmd The command and the arguments that should be run
  9233. @param stdoutFilename The filename that stdout should be saved to
  9234. @param stderrFilename The filename that stderr should be saved to
  9235. @param tailLength The length of the tail to be saved.
  9236. @param pidFileName The name of the pid-file
  9237. @return the modified command that should be run]]>
  9238. </doc>
  9239. </method>
  9240. <method name="addCommand" return="java.lang.String"
  9241. abstract="false" native="false" synchronized="false"
  9242. static="true" final="false" visibility="public"
  9243. deprecated="not deprecated">
  9244. <param name="cmd" type="java.util.List"/>
  9245. <param name="isExecutable" type="boolean"/>
  9246. <exception name="IOException" type="java.io.IOException"/>
  9247. <doc>
  9248. <![CDATA[Add quotes to each of the command strings and
  9249. return as a single string
  9250. @param cmd The command to be quoted
  9251. @param isExecutable makes shell path if the first
  9252. argument is executable
  9253. @return returns The quoted string.
  9254. @throws IOException]]>
  9255. </doc>
  9256. </method>
  9257. <method name="captureDebugOut" return="java.util.List"
  9258. abstract="false" native="false" synchronized="false"
  9259. static="true" final="false" visibility="public"
  9260. deprecated="not deprecated">
  9261. <param name="cmd" type="java.util.List"/>
  9262. <param name="debugoutFilename" type="java.io.File"/>
  9263. <exception name="IOException" type="java.io.IOException"/>
  9264. <doc>
  9265. <![CDATA[Wrap a command in a shell to capture debug script's
  9266. stdout and stderr to debugout.
  9267. @param cmd The command and the arguments that should be run
  9268. @param debugoutFilename The filename that stdout and stderr
  9269. should be saved to.
  9270. @return the modified command that should be run
  9271. @throws IOException]]>
  9272. </doc>
  9273. </method>
  9274. <doc>
  9275. <![CDATA[A simple logger to handle the task-specific user logs.
  9276. This class uses the system property <code>hadoop.log.dir</code>.]]>
  9277. </doc>
  9278. </class>
  9279. <!-- end class org.apache.hadoop.mapred.TaskLog -->
  9280. <!-- start class org.apache.hadoop.mapred.TaskLog.LogName -->
  9281. <class name="TaskLog.LogName" extends="java.lang.Enum"
  9282. abstract="false"
  9283. static="true" final="true" visibility="public"
  9284. deprecated="not deprecated">
  9285. <method name="values" return="org.apache.hadoop.mapred.TaskLog.LogName[]"
  9286. abstract="false" native="false" synchronized="false"
  9287. static="true" final="false" visibility="public"
  9288. deprecated="not deprecated">
  9289. </method>
  9290. <method name="valueOf" return="org.apache.hadoop.mapred.TaskLog.LogName"
  9291. abstract="false" native="false" synchronized="false"
  9292. static="true" final="false" visibility="public"
  9293. deprecated="not deprecated">
  9294. <param name="name" type="java.lang.String"/>
  9295. </method>
  9296. <method name="toString" return="java.lang.String"
  9297. abstract="false" native="false" synchronized="false"
  9298. static="false" final="false" visibility="public"
  9299. deprecated="not deprecated">
  9300. </method>
  9301. <field name="STDOUT" type="org.apache.hadoop.mapred.TaskLog.LogName"
  9302. transient="false" volatile="false"
  9303. static="true" final="true" visibility="public"
  9304. deprecated="not deprecated">
  9305. <doc>
  9306. <![CDATA[Log on the stdout of the task.]]>
  9307. </doc>
  9308. </field>
  9309. <field name="STDERR" type="org.apache.hadoop.mapred.TaskLog.LogName"
  9310. transient="false" volatile="false"
  9311. static="true" final="true" visibility="public"
  9312. deprecated="not deprecated">
  9313. <doc>
  9314. <![CDATA[Log on the stderr of the task.]]>
  9315. </doc>
  9316. </field>
  9317. <field name="SYSLOG" type="org.apache.hadoop.mapred.TaskLog.LogName"
  9318. transient="false" volatile="false"
  9319. static="true" final="true" visibility="public"
  9320. deprecated="not deprecated">
  9321. <doc>
  9322. <![CDATA[Log on the map-reduce system logs of the task.]]>
  9323. </doc>
  9324. </field>
  9325. <field name="PROFILE" type="org.apache.hadoop.mapred.TaskLog.LogName"
  9326. transient="false" volatile="false"
  9327. static="true" final="true" visibility="public"
  9328. deprecated="not deprecated">
  9329. <doc>
  9330. <![CDATA[The java profiler information.]]>
  9331. </doc>
  9332. </field>
  9333. <field name="DEBUGOUT" type="org.apache.hadoop.mapred.TaskLog.LogName"
  9334. transient="false" volatile="false"
  9335. static="true" final="true" visibility="public"
  9336. deprecated="not deprecated">
  9337. <doc>
  9338. <![CDATA[Log the debug script's stdout]]>
  9339. </doc>
  9340. </field>
  9341. <doc>
  9342. <![CDATA[The filter for userlogs.]]>
  9343. </doc>
  9344. </class>
  9345. <!-- end class org.apache.hadoop.mapred.TaskLog.LogName -->
  9346. <!-- start class org.apache.hadoop.mapred.TaskLogAppender -->
  9347. <class name="TaskLogAppender" extends="org.apache.log4j.FileAppender"
  9348. abstract="false"
  9349. static="false" final="false" visibility="public"
  9350. deprecated="not deprecated">
  9351. <constructor name="TaskLogAppender"
  9352. static="false" final="false" visibility="public"
  9353. deprecated="not deprecated">
  9354. </constructor>
  9355. <method name="activateOptions"
  9356. abstract="false" native="false" synchronized="false"
  9357. static="false" final="false" visibility="public"
  9358. deprecated="not deprecated">
  9359. </method>
  9360. <method name="append"
  9361. abstract="false" native="false" synchronized="false"
  9362. static="false" final="false" visibility="public"
  9363. deprecated="not deprecated">
  9364. <param name="event" type="org.apache.log4j.spi.LoggingEvent"/>
  9365. </method>
  9366. <method name="flush"
  9367. abstract="false" native="false" synchronized="false"
  9368. static="false" final="false" visibility="public"
  9369. deprecated="not deprecated">
  9370. </method>
  9371. <method name="close"
  9372. abstract="false" native="false" synchronized="true"
  9373. static="false" final="false" visibility="public"
  9374. deprecated="not deprecated">
  9375. </method>
  9376. <method name="getTaskId" return="java.lang.String"
  9377. abstract="false" native="false" synchronized="false"
  9378. static="false" final="false" visibility="public"
  9379. deprecated="not deprecated">
  9380. <doc>
  9381. <![CDATA[Getter/Setter methods for log4j.]]>
  9382. </doc>
  9383. </method>
  9384. <method name="setTaskId"
  9385. abstract="false" native="false" synchronized="false"
  9386. static="false" final="false" visibility="public"
  9387. deprecated="not deprecated">
  9388. <param name="taskId" type="java.lang.String"/>
  9389. </method>
  9390. <method name="getTotalLogFileSize" return="long"
  9391. abstract="false" native="false" synchronized="false"
  9392. static="false" final="false" visibility="public"
  9393. deprecated="not deprecated">
  9394. </method>
  9395. <method name="setTotalLogFileSize"
  9396. abstract="false" native="false" synchronized="false"
  9397. static="false" final="false" visibility="public"
  9398. deprecated="not deprecated">
  9399. <param name="logSize" type="long"/>
  9400. </method>
  9401. <doc>
  9402. <![CDATA[A simple log4j-appender for the task child's
  9403. map-reduce system logs.]]>
  9404. </doc>
  9405. </class>
  9406. <!-- end class org.apache.hadoop.mapred.TaskLogAppender -->
  9407. <!-- start class org.apache.hadoop.mapred.TaskLogServlet -->
  9408. <class name="TaskLogServlet" extends="javax.servlet.http.HttpServlet"
  9409. abstract="false"
  9410. static="false" final="false" visibility="public"
  9411. deprecated="not deprecated">
  9412. <constructor name="TaskLogServlet"
  9413. static="false" final="false" visibility="public"
  9414. deprecated="not deprecated">
  9415. </constructor>
  9416. <method name="getTaskLogUrl" return="java.lang.String"
  9417. abstract="false" native="false" synchronized="false"
  9418. static="true" final="false" visibility="public"
  9419. deprecated="not deprecated">
  9420. <param name="taskTrackerHostName" type="java.lang.String"/>
  9421. <param name="httpPort" type="java.lang.String"/>
  9422. <param name="taskAttemptID" type="java.lang.String"/>
  9423. <doc>
  9424. <![CDATA[Construct the taskLogUrl
  9425. @param taskTrackerHostName
  9426. @param httpPort
  9427. @param taskAttemptID
  9428. @return the taskLogUrl]]>
  9429. </doc>
  9430. </method>
  9431. <method name="doGet"
  9432. abstract="false" native="false" synchronized="false"
  9433. static="false" final="false" visibility="public"
  9434. deprecated="not deprecated">
  9435. <param name="request" type="javax.servlet.http.HttpServletRequest"/>
  9436. <param name="response" type="javax.servlet.http.HttpServletResponse"/>
  9437. <exception name="ServletException" type="javax.servlet.ServletException"/>
  9438. <exception name="IOException" type="java.io.IOException"/>
  9439. <doc>
  9440. <![CDATA[Get the logs via http.]]>
  9441. </doc>
  9442. </method>
  9443. <doc>
  9444. <![CDATA[A servlet that is run by the TaskTrackers to provide the task logs via http.]]>
  9445. </doc>
  9446. </class>
  9447. <!-- end class org.apache.hadoop.mapred.TaskLogServlet -->
  9448. <!-- start class org.apache.hadoop.mapred.TaskReport -->
  9449. <class name="TaskReport" extends="java.lang.Object"
  9450. abstract="false"
  9451. static="false" final="false" visibility="public"
  9452. deprecated="not deprecated">
  9453. <implements name="org.apache.hadoop.io.Writable"/>
  9454. <constructor name="TaskReport"
  9455. static="false" final="false" visibility="public"
  9456. deprecated="not deprecated">
  9457. </constructor>
  9458. <method name="getTaskId" return="java.lang.String"
  9459. abstract="false" native="false" synchronized="false"
  9460. static="false" final="false" visibility="public"
  9461. deprecated="use {@link #getTaskID()} instead">
  9462. <doc>
  9463. <![CDATA[@deprecated use {@link #getTaskID()} instead]]>
  9464. </doc>
  9465. </method>
  9466. <method name="getTaskID" return="org.apache.hadoop.mapred.TaskID"
  9467. abstract="false" native="false" synchronized="false"
  9468. static="false" final="false" visibility="public"
  9469. deprecated="not deprecated">
  9470. <doc>
  9471. <![CDATA[The id of the task.]]>
  9472. </doc>
  9473. </method>
  9474. <method name="getProgress" return="float"
  9475. abstract="false" native="false" synchronized="false"
  9476. static="false" final="false" visibility="public"
  9477. deprecated="not deprecated">
  9478. <doc>
  9479. <![CDATA[The amount completed, between zero and one.]]>
  9480. </doc>
  9481. </method>
  9482. <method name="getState" return="java.lang.String"
  9483. abstract="false" native="false" synchronized="false"
  9484. static="false" final="false" visibility="public"
  9485. deprecated="not deprecated">
  9486. <doc>
  9487. <![CDATA[The most recent state, reported by a {@link Reporter}.]]>
  9488. </doc>
  9489. </method>
  9490. <method name="getDiagnostics" return="java.lang.String[]"
  9491. abstract="false" native="false" synchronized="false"
  9492. static="false" final="false" visibility="public"
  9493. deprecated="not deprecated">
  9494. <doc>
  9495. <![CDATA[A list of error messages.]]>
  9496. </doc>
  9497. </method>
  9498. <method name="getCounters" return="org.apache.hadoop.mapred.Counters"
  9499. abstract="false" native="false" synchronized="false"
  9500. static="false" final="false" visibility="public"
  9501. deprecated="not deprecated">
  9502. <doc>
  9503. <![CDATA[A table of counters.]]>
  9504. </doc>
  9505. </method>
  9506. <method name="getCurrentStatus" return="org.apache.hadoop.mapred.TIPStatus"
  9507. abstract="false" native="false" synchronized="false"
  9508. static="false" final="false" visibility="public"
  9509. deprecated="not deprecated">
  9510. <doc>
  9511. <![CDATA[The current status]]>
  9512. </doc>
  9513. </method>
  9514. <method name="getFinishTime" return="long"
  9515. abstract="false" native="false" synchronized="false"
  9516. static="false" final="false" visibility="public"
  9517. deprecated="not deprecated">
  9518. <doc>
  9519. <![CDATA[Get finish time of task.
  9520. @return 0, if finish time was not set else returns finish time.]]>
  9521. </doc>
  9522. </method>
  9523. <method name="getStartTime" return="long"
  9524. abstract="false" native="false" synchronized="false"
  9525. static="false" final="false" visibility="public"
  9526. deprecated="not deprecated">
  9527. <doc>
  9528. <![CDATA[Get start time of task.
  9529. @return 0 if start time was not set, else start time.]]>
  9530. </doc>
  9531. </method>
  9532. <method name="setSuccessfulAttempt"
  9533. abstract="false" native="false" synchronized="false"
  9534. static="false" final="false" visibility="public"
  9535. deprecated="not deprecated">
  9536. <param name="t" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  9537. <doc>
  9538. <![CDATA[set successful attempt ID of the task.]]>
  9539. </doc>
  9540. </method>
  9541. <method name="getSuccessfulTaskAttempt" return="org.apache.hadoop.mapred.TaskAttemptID"
  9542. abstract="false" native="false" synchronized="false"
  9543. static="false" final="false" visibility="public"
  9544. deprecated="not deprecated">
  9545. <doc>
  9546. <![CDATA[Get the attempt ID that took this task to completion]]>
  9547. </doc>
  9548. </method>
  9549. <method name="setRunningTaskAttempts"
  9550. abstract="false" native="false" synchronized="false"
  9551. static="false" final="false" visibility="public"
  9552. deprecated="not deprecated">
  9553. <param name="runningAttempts" type="java.util.Collection"/>
  9554. <doc>
  9555. <![CDATA[set running attempt(s) of the task.]]>
  9556. </doc>
  9557. </method>
  9558. <method name="getRunningTaskAttempts" return="java.util.Collection"
  9559. abstract="false" native="false" synchronized="false"
  9560. static="false" final="false" visibility="public"
  9561. deprecated="not deprecated">
  9562. <doc>
  9563. <![CDATA[Get the running task attempt IDs for this task]]>
  9564. </doc>
  9565. </method>
  9566. <method name="equals" return="boolean"
  9567. abstract="false" native="false" synchronized="false"
  9568. static="false" final="false" visibility="public"
  9569. deprecated="not deprecated">
  9570. <param name="o" type="java.lang.Object"/>
  9571. </method>
  9572. <method name="hashCode" return="int"
  9573. abstract="false" native="false" synchronized="false"
  9574. static="false" final="false" visibility="public"
  9575. deprecated="not deprecated">
  9576. </method>
  9577. <method name="write"
  9578. abstract="false" native="false" synchronized="false"
  9579. static="false" final="false" visibility="public"
  9580. deprecated="not deprecated">
  9581. <param name="out" type="java.io.DataOutput"/>
  9582. <exception name="IOException" type="java.io.IOException"/>
  9583. </method>
  9584. <method name="readFields"
  9585. abstract="false" native="false" synchronized="false"
  9586. static="false" final="false" visibility="public"
  9587. deprecated="not deprecated">
  9588. <param name="in" type="java.io.DataInput"/>
  9589. <exception name="IOException" type="java.io.IOException"/>
  9590. </method>
  9591. <doc>
  9592. <![CDATA[A report on the state of a task.]]>
  9593. </doc>
  9594. </class>
  9595. <!-- end class org.apache.hadoop.mapred.TaskReport -->
  9596. <!-- start class org.apache.hadoop.mapred.TaskTracker -->
  9597. <class name="TaskTracker" extends="java.lang.Object"
  9598. abstract="false"
  9599. static="false" final="false" visibility="public"
  9600. deprecated="not deprecated">
  9601. <implements name="org.apache.hadoop.mapred.MRConstants"/>
  9602. <implements name="org.apache.hadoop.mapred.TaskUmbilicalProtocol"/>
  9603. <implements name="java.lang.Runnable"/>
  9604. <constructor name="TaskTracker" type="org.apache.hadoop.mapred.JobConf"
  9605. static="false" final="false" visibility="public"
  9606. deprecated="not deprecated">
  9607. <exception name="IOException" type="java.io.IOException"/>
  9608. <doc>
  9609. <![CDATA[Start with the local machine name, and the default JobTracker]]>
  9610. </doc>
  9611. </constructor>
  9612. <method name="getTaskTrackerInstrumentation" return="org.apache.hadoop.mapred.TaskTrackerInstrumentation"
  9613. abstract="false" native="false" synchronized="false"
  9614. static="false" final="false" visibility="public"
  9615. deprecated="not deprecated">
  9616. </method>
  9617. <method name="getProtocolVersion" return="long"
  9618. abstract="false" native="false" synchronized="false"
  9619. static="false" final="false" visibility="public"
  9620. deprecated="not deprecated">
  9621. <param name="protocol" type="java.lang.String"/>
  9622. <param name="clientVersion" type="long"/>
  9623. <exception name="IOException" type="java.io.IOException"/>
  9624. </method>
  9625. <method name="getInstrumentationClass" return="java.lang.Class"
  9626. abstract="false" native="false" synchronized="false"
  9627. static="true" final="false" visibility="public"
  9628. deprecated="not deprecated">
  9629. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  9630. </method>
  9631. <method name="setInstrumentationClass"
  9632. abstract="false" native="false" synchronized="false"
  9633. static="true" final="false" visibility="public"
  9634. deprecated="not deprecated">
  9635. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  9636. <param name="t" type="java.lang.Class"/>
  9637. </method>
  9638. <method name="cleanupStorage"
  9639. abstract="false" native="false" synchronized="false"
  9640. static="false" final="false" visibility="public"
  9641. deprecated="not deprecated">
  9642. <exception name="IOException" type="java.io.IOException"/>
  9643. <doc>
  9644. <![CDATA[Removes all contents of temporary storage. Called upon
  9645. startup, to remove any leftovers from previous run.]]>
  9646. </doc>
  9647. </method>
  9648. <method name="shutdown"
  9649. abstract="false" native="false" synchronized="true"
  9650. static="false" final="false" visibility="public"
  9651. deprecated="not deprecated">
  9652. <exception name="IOException" type="java.io.IOException"/>
  9653. </method>
  9654. <method name="close"
  9655. abstract="false" native="false" synchronized="true"
  9656. static="false" final="false" visibility="public"
  9657. deprecated="not deprecated">
  9658. <exception name="IOException" type="java.io.IOException"/>
  9659. <doc>
  9660. <![CDATA[Close down the TaskTracker and all its components. We must also shutdown
  9661. any running tasks or threads, and cleanup disk space. A new TaskTracker
  9662. within the same process space might be restarted, so everything must be
  9663. clean.]]>
  9664. </doc>
  9665. </method>
  9666. <method name="getJobClient" return="org.apache.hadoop.mapred.InterTrackerProtocol"
  9667. abstract="false" native="false" synchronized="false"
  9668. static="false" final="false" visibility="public"
  9669. deprecated="not deprecated">
  9670. <doc>
  9671. <![CDATA[The connection to the JobTracker, used by the TaskRunner
  9672. for locating remote files.]]>
  9673. </doc>
  9674. </method>
  9675. <method name="getTaskTrackerReportAddress" return="java.net.InetSocketAddress"
  9676. abstract="false" native="false" synchronized="true"
  9677. static="false" final="false" visibility="public"
  9678. deprecated="not deprecated">
  9679. <doc>
  9680. <![CDATA[Return the port at which the tasktracker bound to]]>
  9681. </doc>
  9682. </method>
  9683. <method name="getJvmManagerInstance" return="org.apache.hadoop.mapred.JvmManager"
  9684. abstract="false" native="false" synchronized="false"
  9685. static="false" final="false" visibility="public"
  9686. deprecated="not deprecated">
  9687. </method>
  9688. <method name="run"
  9689. abstract="false" native="false" synchronized="false"
  9690. static="false" final="false" visibility="public"
  9691. deprecated="not deprecated">
  9692. <doc>
  9693. <![CDATA[The server retry loop.
  9694. This while-loop attempts to connect to the JobTracker. It only
  9695. loops when the old TaskTracker has gone bad (its state is
  9696. stale somehow) and we need to reinitialize everything.]]>
  9697. </doc>
  9698. </method>
  9699. <method name="getTask" return="org.apache.hadoop.mapred.JvmTask"
  9700. abstract="false" native="false" synchronized="true"
  9701. static="false" final="false" visibility="public"
  9702. deprecated="not deprecated">
  9703. <param name="jvmId" type="org.apache.hadoop.mapred.JVMId"/>
  9704. <exception name="IOException" type="java.io.IOException"/>
  9705. <doc>
  9706. <![CDATA[Called upon startup by the child process, to fetch Task data.]]>
  9707. </doc>
  9708. </method>
  9709. <method name="statusUpdate" return="boolean"
  9710. abstract="false" native="false" synchronized="true"
  9711. static="false" final="false" visibility="public"
  9712. deprecated="not deprecated">
  9713. <param name="taskid" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  9714. <param name="taskStatus" type="org.apache.hadoop.mapred.TaskStatus"/>
  9715. <exception name="IOException" type="java.io.IOException"/>
  9716. <doc>
  9717. <![CDATA[Called periodically to report Task progress, from 0.0 to 1.0.]]>
  9718. </doc>
  9719. </method>
  9720. <method name="reportDiagnosticInfo"
  9721. abstract="false" native="false" synchronized="true"
  9722. static="false" final="false" visibility="public"
  9723. deprecated="not deprecated">
  9724. <param name="taskid" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  9725. <param name="info" type="java.lang.String"/>
  9726. <exception name="IOException" type="java.io.IOException"/>
  9727. <doc>
  9728. <![CDATA[Called when the task dies before completion, and we want to report back
  9729. diagnostic info]]>
  9730. </doc>
  9731. </method>
  9732. <method name="reportNextRecordRange"
  9733. abstract="false" native="false" synchronized="true"
  9734. static="false" final="false" visibility="public"
  9735. deprecated="not deprecated">
  9736. <param name="taskid" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  9737. <param name="range" type="org.apache.hadoop.mapred.SortedRanges.Range"/>
  9738. <exception name="IOException" type="java.io.IOException"/>
  9739. </method>
  9740. <method name="ping" return="boolean"
  9741. abstract="false" native="false" synchronized="true"
  9742. static="false" final="false" visibility="public"
  9743. deprecated="not deprecated">
  9744. <param name="taskid" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  9745. <exception name="IOException" type="java.io.IOException"/>
  9746. <doc>
  9747. <![CDATA[Child checking to see if we're alive. Normally does nothing.]]>
  9748. </doc>
  9749. </method>
  9750. <method name="commitPending"
  9751. abstract="false" native="false" synchronized="true"
  9752. static="false" final="false" visibility="public"
  9753. deprecated="not deprecated">
  9754. <param name="taskid" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  9755. <param name="taskStatus" type="org.apache.hadoop.mapred.TaskStatus"/>
  9756. <exception name="IOException" type="java.io.IOException"/>
  9757. <doc>
  9758. <![CDATA[Task is reporting that it is in commit_pending
  9759. and it is waiting for the commit Response]]>
  9760. </doc>
  9761. </method>
  9762. <method name="canCommit" return="boolean"
  9763. abstract="false" native="false" synchronized="true"
  9764. static="false" final="false" visibility="public"
  9765. deprecated="not deprecated">
  9766. <param name="taskid" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  9767. <doc>
  9768. <![CDATA[Child checking whether it can commit]]>
  9769. </doc>
  9770. </method>
  9771. <method name="done"
  9772. abstract="false" native="false" synchronized="true"
  9773. static="false" final="false" visibility="public"
  9774. deprecated="not deprecated">
  9775. <param name="taskid" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  9776. <exception name="IOException" type="java.io.IOException"/>
  9777. <doc>
  9778. <![CDATA[The task is done.]]>
  9779. </doc>
  9780. </method>
  9781. <method name="shuffleError"
  9782. abstract="false" native="false" synchronized="true"
  9783. static="false" final="false" visibility="public"
  9784. deprecated="not deprecated">
  9785. <param name="taskId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  9786. <param name="message" type="java.lang.String"/>
  9787. <exception name="IOException" type="java.io.IOException"/>
  9788. <doc>
  9789. <![CDATA[A reduce-task failed to shuffle the map-outputs. Kill the task.]]>
  9790. </doc>
  9791. </method>
  9792. <method name="fsError"
  9793. abstract="false" native="false" synchronized="true"
  9794. static="false" final="false" visibility="public"
  9795. deprecated="not deprecated">
  9796. <param name="taskId" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  9797. <param name="message" type="java.lang.String"/>
  9798. <exception name="IOException" type="java.io.IOException"/>
  9799. <doc>
  9800. <![CDATA[A child task had a local filesystem error. Kill the task.]]>
  9801. </doc>
  9802. </method>
  9803. <method name="getMapCompletionEvents" return="org.apache.hadoop.mapred.MapTaskCompletionEventsUpdate"
  9804. abstract="false" native="false" synchronized="true"
  9805. static="false" final="false" visibility="public"
  9806. deprecated="not deprecated">
  9807. <param name="jobId" type="org.apache.hadoop.mapred.JobID"/>
  9808. <param name="fromEventId" type="int"/>
  9809. <param name="maxLocs" type="int"/>
  9810. <param name="id" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  9811. <exception name="IOException" type="java.io.IOException"/>
  9812. </method>
  9813. <method name="mapOutputLost"
  9814. abstract="false" native="false" synchronized="true"
  9815. static="false" final="false" visibility="public"
  9816. deprecated="not deprecated">
  9817. <param name="taskid" type="org.apache.hadoop.mapred.TaskAttemptID"/>
  9818. <param name="errorMsg" type="java.lang.String"/>
  9819. <exception name="IOException" type="java.io.IOException"/>
  9820. <doc>
  9821. <![CDATA[A completed map task's output has been lost.]]>
  9822. </doc>
  9823. </method>
  9824. <method name="isIdle" return="boolean"
  9825. abstract="false" native="false" synchronized="true"
  9826. static="false" final="false" visibility="public"
  9827. deprecated="not deprecated">
  9828. <doc>
  9829. <![CDATA[Is this task tracker idle?
  9830. @return has this task tracker finished and cleaned up all of its tasks?]]>
  9831. </doc>
  9832. </method>
  9833. <method name="main"
  9834. abstract="false" native="false" synchronized="false"
  9835. static="true" final="false" visibility="public"
  9836. deprecated="not deprecated">
  9837. <param name="argv" type="java.lang.String[]"/>
  9838. <exception name="Exception" type="java.lang.Exception"/>
  9839. <doc>
  9840. <![CDATA[Start the TaskTracker, point toward the indicated JobTracker]]>
  9841. </doc>
  9842. </method>
  9843. <method name="isTaskMemoryManagerEnabled" return="boolean"
  9844. abstract="false" native="false" synchronized="false"
  9845. static="false" final="false" visibility="public"
  9846. deprecated="not deprecated">
  9847. <doc>
  9848. <![CDATA[Is the TaskMemoryManager Enabled on this system?
  9849. @return true if enabled, false otherwise.]]>
  9850. </doc>
  9851. </method>
  9852. <method name="getTaskMemoryManager" return="org.apache.hadoop.mapred.TaskMemoryManagerThread"
  9853. abstract="false" native="false" synchronized="false"
  9854. static="false" final="false" visibility="public"
  9855. deprecated="not deprecated">
  9856. </method>
  9857. <field name="LOG" type="org.apache.commons.logging.Log"
  9858. transient="false" volatile="false"
  9859. static="true" final="true" visibility="public"
  9860. deprecated="not deprecated">
  9861. </field>
  9862. <field name="MR_CLIENTTRACE_FORMAT" type="java.lang.String"
  9863. transient="false" volatile="false"
  9864. static="true" final="true" visibility="public"
  9865. deprecated="not deprecated">
  9866. </field>
  9867. <field name="ClientTraceLog" type="org.apache.commons.logging.Log"
  9868. transient="false" volatile="false"
  9869. static="true" final="true" visibility="public"
  9870. deprecated="not deprecated">
  9871. </field>
  9872. <doc>
  9873. <![CDATA[TaskTracker is a process that starts and tracks MR Tasks
  9874. in a networked environment. It contacts the JobTracker
  9875. for Task assignments and reporting results.]]>
  9876. </doc>
  9877. </class>
  9878. <!-- end class org.apache.hadoop.mapred.TaskTracker -->
  9879. <!-- start class org.apache.hadoop.mapred.TaskTracker.MapOutputServlet -->
  9880. <class name="TaskTracker.MapOutputServlet" extends="javax.servlet.http.HttpServlet"
  9881. abstract="false"
  9882. static="true" final="false" visibility="public"
  9883. deprecated="not deprecated">
  9884. <constructor name="TaskTracker.MapOutputServlet"
  9885. static="false" final="false" visibility="public"
  9886. deprecated="not deprecated">
  9887. </constructor>
  9888. <method name="doGet"
  9889. abstract="false" native="false" synchronized="false"
  9890. static="false" final="false" visibility="public"
  9891. deprecated="not deprecated">
  9892. <param name="request" type="javax.servlet.http.HttpServletRequest"/>
  9893. <param name="response" type="javax.servlet.http.HttpServletResponse"/>
  9894. <exception name="ServletException" type="javax.servlet.ServletException"/>
  9895. <exception name="IOException" type="java.io.IOException"/>
  9896. </method>
  9897. <doc>
  9898. <![CDATA[This class is used in TaskTracker's Jetty to serve the map outputs
  9899. to other nodes.]]>
  9900. </doc>
  9901. </class>
  9902. <!-- end class org.apache.hadoop.mapred.TaskTracker.MapOutputServlet -->
  9903. <!-- start class org.apache.hadoop.mapred.TextInputFormat -->
  9904. <class name="TextInputFormat" extends="org.apache.hadoop.mapred.FileInputFormat"
  9905. abstract="false"
  9906. static="false" final="false" visibility="public"
  9907. deprecated="Use {@link org.apache.hadoop.mapreduce.lib.input.TextInputFormat}
  9908. instead.">
  9909. <implements name="org.apache.hadoop.mapred.JobConfigurable"/>
  9910. <constructor name="TextInputFormat"
  9911. static="false" final="false" visibility="public"
  9912. deprecated="not deprecated">
  9913. </constructor>
  9914. <method name="configure"
  9915. abstract="false" native="false" synchronized="false"
  9916. static="false" final="false" visibility="public"
  9917. deprecated="not deprecated">
  9918. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  9919. </method>
  9920. <method name="isSplitable" return="boolean"
  9921. abstract="false" native="false" synchronized="false"
  9922. static="false" final="false" visibility="protected"
  9923. deprecated="not deprecated">
  9924. <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
  9925. <param name="file" type="org.apache.hadoop.fs.Path"/>
  9926. </method>
  9927. <method name="getRecordReader" return="org.apache.hadoop.mapred.RecordReader"
  9928. abstract="false" native="false" synchronized="false"
  9929. static="false" final="false" visibility="public"
  9930. deprecated="not deprecated">
  9931. <param name="genericSplit" type="org.apache.hadoop.mapred.InputSplit"/>
  9932. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  9933. <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
  9934. <exception name="IOException" type="java.io.IOException"/>
  9935. </method>
  9936. <doc>
  9937. <![CDATA[An {@link InputFormat} for plain text files. Files are broken into lines.
  9938. Either linefeed or carriage-return are used to signal end of line. Keys are
  9939. the position in the file, and values are the line of text..
  9940. @deprecated Use {@link org.apache.hadoop.mapreduce.lib.input.TextInputFormat}
  9941. instead.]]>
  9942. </doc>
  9943. </class>
  9944. <!-- end class org.apache.hadoop.mapred.TextInputFormat -->
  9945. <!-- start class org.apache.hadoop.mapred.TextOutputFormat -->
  9946. <class name="TextOutputFormat" extends="org.apache.hadoop.mapred.FileOutputFormat"
  9947. abstract="false"
  9948. static="false" final="false" visibility="public"
  9949. deprecated="Use
  9950. {@link org.apache.hadoop.mapreduce.lib.output.TextOutputFormat} instead.">
  9951. <constructor name="TextOutputFormat"
  9952. static="false" final="false" visibility="public"
  9953. deprecated="not deprecated">
  9954. </constructor>
  9955. <method name="getRecordWriter" return="org.apache.hadoop.mapred.RecordWriter"
  9956. abstract="false" native="false" synchronized="false"
  9957. static="false" final="false" visibility="public"
  9958. deprecated="not deprecated">
  9959. <param name="ignored" type="org.apache.hadoop.fs.FileSystem"/>
  9960. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  9961. <param name="name" type="java.lang.String"/>
  9962. <param name="progress" type="org.apache.hadoop.util.Progressable"/>
  9963. <exception name="IOException" type="java.io.IOException"/>
  9964. </method>
  9965. <doc>
  9966. <![CDATA[An {@link OutputFormat} that writes plain text files.
  9967. @deprecated Use
  9968. {@link org.apache.hadoop.mapreduce.lib.output.TextOutputFormat} instead.]]>
  9969. </doc>
  9970. </class>
  9971. <!-- end class org.apache.hadoop.mapred.TextOutputFormat -->
  9972. <!-- start class org.apache.hadoop.mapred.TextOutputFormat.LineRecordWriter -->
  9973. <class name="TextOutputFormat.LineRecordWriter" extends="java.lang.Object"
  9974. abstract="false"
  9975. static="true" final="false" visibility="protected"
  9976. deprecated="not deprecated">
  9977. <implements name="org.apache.hadoop.mapred.RecordWriter"/>
  9978. <constructor name="TextOutputFormat.LineRecordWriter" type="java.io.DataOutputStream, java.lang.String"
  9979. static="false" final="false" visibility="public"
  9980. deprecated="not deprecated">
  9981. </constructor>
  9982. <constructor name="TextOutputFormat.LineRecordWriter" type="java.io.DataOutputStream"
  9983. static="false" final="false" visibility="public"
  9984. deprecated="not deprecated">
  9985. </constructor>
  9986. <method name="write"
  9987. abstract="false" native="false" synchronized="true"
  9988. static="false" final="false" visibility="public"
  9989. deprecated="not deprecated">
  9990. <param name="key" type="java.lang.Object"/>
  9991. <param name="value" type="java.lang.Object"/>
  9992. <exception name="IOException" type="java.io.IOException"/>
  9993. </method>
  9994. <method name="close"
  9995. abstract="false" native="false" synchronized="true"
  9996. static="false" final="false" visibility="public"
  9997. deprecated="not deprecated">
  9998. <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
  9999. <exception name="IOException" type="java.io.IOException"/>
  10000. </method>
  10001. <field name="out" type="java.io.DataOutputStream"
  10002. transient="false" volatile="false"
  10003. static="false" final="false" visibility="protected"
  10004. deprecated="not deprecated">
  10005. </field>
  10006. </class>
  10007. <!-- end class org.apache.hadoop.mapred.TextOutputFormat.LineRecordWriter -->
  10008. <!-- start class org.apache.hadoop.mapred.TIPStatus -->
  10009. <class name="TIPStatus" extends="java.lang.Enum"
  10010. abstract="false"
  10011. static="false" final="true" visibility="public"
  10012. deprecated="not deprecated">
  10013. <method name="values" return="org.apache.hadoop.mapred.TIPStatus[]"
  10014. abstract="false" native="false" synchronized="false"
  10015. static="true" final="false" visibility="public"
  10016. deprecated="not deprecated">
  10017. </method>
  10018. <method name="valueOf" return="org.apache.hadoop.mapred.TIPStatus"
  10019. abstract="false" native="false" synchronized="false"
  10020. static="true" final="false" visibility="public"
  10021. deprecated="not deprecated">
  10022. <param name="name" type="java.lang.String"/>
  10023. </method>
  10024. <field name="PENDING" type="org.apache.hadoop.mapred.TIPStatus"
  10025. transient="false" volatile="false"
  10026. static="true" final="true" visibility="public"
  10027. deprecated="not deprecated">
  10028. </field>
  10029. <field name="RUNNING" type="org.apache.hadoop.mapred.TIPStatus"
  10030. transient="false" volatile="false"
  10031. static="true" final="true" visibility="public"
  10032. deprecated="not deprecated">
  10033. </field>
  10034. <field name="COMPLETE" type="org.apache.hadoop.mapred.TIPStatus"
  10035. transient="false" volatile="false"
  10036. static="true" final="true" visibility="public"
  10037. deprecated="not deprecated">
  10038. </field>
  10039. <field name="KILLED" type="org.apache.hadoop.mapred.TIPStatus"
  10040. transient="false" volatile="false"
  10041. static="true" final="true" visibility="public"
  10042. deprecated="not deprecated">
  10043. </field>
  10044. <field name="FAILED" type="org.apache.hadoop.mapred.TIPStatus"
  10045. transient="false" volatile="false"
  10046. static="true" final="true" visibility="public"
  10047. deprecated="not deprecated">
  10048. </field>
  10049. <doc>
  10050. <![CDATA[The states of a {@link TaskInProgress} as seen by the JobTracker.]]>
  10051. </doc>
  10052. </class>
  10053. <!-- end class org.apache.hadoop.mapred.TIPStatus -->
  10054. </package>
  10055. <package name="org.apache.hadoop.mapred.jobcontrol">
  10056. <!-- start class org.apache.hadoop.mapred.jobcontrol.Job -->
  10057. <class name="Job" extends="java.lang.Object"
  10058. abstract="false"
  10059. static="false" final="false" visibility="public"
  10060. deprecated="not deprecated">
  10061. <constructor name="Job" type="org.apache.hadoop.mapred.JobConf, java.util.ArrayList"
  10062. static="false" final="false" visibility="public"
  10063. deprecated="not deprecated">
  10064. <exception name="IOException" type="java.io.IOException"/>
  10065. <doc>
  10066. <![CDATA[Construct a job.
  10067. @param jobConf a mapred job configuration representing a job to be executed.
  10068. @param dependingJobs an array of jobs the current job depends on]]>
  10069. </doc>
  10070. </constructor>
  10071. <constructor name="Job" type="org.apache.hadoop.mapred.JobConf"
  10072. static="false" final="false" visibility="public"
  10073. deprecated="not deprecated">
  10074. <exception name="IOException" type="java.io.IOException"/>
  10075. <doc>
  10076. <![CDATA[Construct a job.
  10077. @param jobConf mapred job configuration representing a job to be executed.
  10078. @throws IOException]]>
  10079. </doc>
  10080. </constructor>
  10081. <method name="toString" return="java.lang.String"
  10082. abstract="false" native="false" synchronized="false"
  10083. static="false" final="false" visibility="public"
  10084. deprecated="not deprecated">
  10085. </method>
  10086. <method name="getJobName" return="java.lang.String"
  10087. abstract="false" native="false" synchronized="false"
  10088. static="false" final="false" visibility="public"
  10089. deprecated="not deprecated">
  10090. <doc>
  10091. <![CDATA[@return the job name of this job]]>
  10092. </doc>
  10093. </method>
  10094. <method name="setJobName"
  10095. abstract="false" native="false" synchronized="false"
  10096. static="false" final="false" visibility="public"
  10097. deprecated="not deprecated">
  10098. <param name="jobName" type="java.lang.String"/>
  10099. <doc>
  10100. <![CDATA[Set the job name for this job.
  10101. @param jobName the job name]]>
  10102. </doc>
  10103. </method>
  10104. <method name="getJobID" return="java.lang.String"
  10105. abstract="false" native="false" synchronized="false"
  10106. static="false" final="false" visibility="public"
  10107. deprecated="not deprecated">
  10108. <doc>
  10109. <![CDATA[@return the job ID of this job assigned by JobControl]]>
  10110. </doc>
  10111. </method>
  10112. <method name="setJobID"
  10113. abstract="false" native="false" synchronized="false"
  10114. static="false" final="false" visibility="public"
  10115. deprecated="not deprecated">
  10116. <param name="id" type="java.lang.String"/>
  10117. <doc>
  10118. <![CDATA[Set the job ID for this job.
  10119. @param id the job ID]]>
  10120. </doc>
  10121. </method>
  10122. <method name="getMapredJobID" return="java.lang.String"
  10123. abstract="false" native="false" synchronized="false"
  10124. static="false" final="false" visibility="public"
  10125. deprecated="use {@link #getAssignedJobID()} instead">
  10126. <doc>
  10127. <![CDATA[@return the mapred ID of this job
  10128. @deprecated use {@link #getAssignedJobID()} instead]]>
  10129. </doc>
  10130. </method>
  10131. <method name="setMapredJobID"
  10132. abstract="false" native="false" synchronized="false"
  10133. static="false" final="false" visibility="public"
  10134. deprecated="use {@link #setAssignedJobID(JobID)} instead">
  10135. <param name="mapredJobID" type="java.lang.String"/>
  10136. <doc>
  10137. <![CDATA[Set the mapred ID for this job.
  10138. @param mapredJobID the mapred job ID for this job.
  10139. @deprecated use {@link #setAssignedJobID(JobID)} instead]]>
  10140. </doc>
  10141. </method>
  10142. <method name="getAssignedJobID" return="org.apache.hadoop.mapred.JobID"
  10143. abstract="false" native="false" synchronized="false"
  10144. static="false" final="false" visibility="public"
  10145. deprecated="not deprecated">
  10146. <doc>
  10147. <![CDATA[@return the mapred ID of this job as assigned by the
  10148. mapred framework.]]>
  10149. </doc>
  10150. </method>
  10151. <method name="setAssignedJobID"
  10152. abstract="false" native="false" synchronized="false"
  10153. static="false" final="false" visibility="public"
  10154. deprecated="not deprecated">
  10155. <param name="mapredJobID" type="org.apache.hadoop.mapred.JobID"/>
  10156. <doc>
  10157. <![CDATA[Set the mapred ID for this job as assigned by the
  10158. mapred framework.
  10159. @param mapredJobID the mapred job ID for this job.]]>
  10160. </doc>
  10161. </method>
  10162. <method name="getJobConf" return="org.apache.hadoop.mapred.JobConf"
  10163. abstract="false" native="false" synchronized="false"
  10164. static="false" final="false" visibility="public"
  10165. deprecated="not deprecated">
  10166. <doc>
  10167. <![CDATA[@return the mapred job conf of this job]]>
  10168. </doc>
  10169. </method>
  10170. <method name="setJobConf"
  10171. abstract="false" native="false" synchronized="false"
  10172. static="false" final="false" visibility="public"
  10173. deprecated="not deprecated">
  10174. <param name="jobConf" type="org.apache.hadoop.mapred.JobConf"/>
  10175. <doc>
  10176. <![CDATA[Set the mapred job conf for this job.
  10177. @param jobConf the mapred job conf for this job.]]>
  10178. </doc>
  10179. </method>
  10180. <method name="getState" return="int"
  10181. abstract="false" native="false" synchronized="true"
  10182. static="false" final="false" visibility="public"
  10183. deprecated="not deprecated">
  10184. <doc>
  10185. <![CDATA[@return the state of this job]]>
  10186. </doc>
  10187. </method>
  10188. <method name="setState"
  10189. abstract="false" native="false" synchronized="true"
  10190. static="false" final="false" visibility="protected"
  10191. deprecated="not deprecated">
  10192. <param name="state" type="int"/>
  10193. <doc>
  10194. <![CDATA[Set the state for this job.
  10195. @param state the new state for this job.]]>
  10196. </doc>
  10197. </method>
  10198. <method name="getMessage" return="java.lang.String"
  10199. abstract="false" native="false" synchronized="false"
  10200. static="false" final="false" visibility="public"
  10201. deprecated="not deprecated">
  10202. <doc>
  10203. <![CDATA[@return the message of this job]]>
  10204. </doc>
  10205. </method>
  10206. <method name="setMessage"
  10207. abstract="false" native="false" synchronized="false"
  10208. static="false" final="false" visibility="public"
  10209. deprecated="not deprecated">
  10210. <param name="message" type="java.lang.String"/>
  10211. <doc>
  10212. <![CDATA[Set the message for this job.
  10213. @param message the message for this job.]]>
  10214. </doc>
  10215. </method>
  10216. <method name="getJobClient" return="org.apache.hadoop.mapred.JobClient"
  10217. abstract="false" native="false" synchronized="false"
  10218. static="false" final="false" visibility="public"
  10219. deprecated="not deprecated">
  10220. <doc>
  10221. <![CDATA[@return the job client of this job]]>
  10222. </doc>
  10223. </method>
  10224. <method name="getDependingJobs" return="java.util.ArrayList"
  10225. abstract="false" native="false" synchronized="false"
  10226. static="false" final="false" visibility="public"
  10227. deprecated="not deprecated">
  10228. <doc>
  10229. <![CDATA[@return the depending jobs of this job]]>
  10230. </doc>
  10231. </method>
  10232. <method name="addDependingJob" return="boolean"
  10233. abstract="false" native="false" synchronized="true"
  10234. static="false" final="false" visibility="public"
  10235. deprecated="not deprecated">
  10236. <param name="dependingJob" type="org.apache.hadoop.mapred.jobcontrol.Job"/>
  10237. <doc>
  10238. <![CDATA[Add a job to this jobs' dependency list. Dependent jobs can only be added while a Job
  10239. is waiting to run, not during or afterwards.
  10240. @param dependingJob Job that this Job depends on.
  10241. @return <tt>true</tt> if the Job was added.]]>
  10242. </doc>
  10243. </method>
  10244. <method name="isCompleted" return="boolean"
  10245. abstract="false" native="false" synchronized="false"
  10246. static="false" final="false" visibility="public"
  10247. deprecated="not deprecated">
  10248. <doc>
  10249. <![CDATA[@return true if this job is in a complete state]]>
  10250. </doc>
  10251. </method>
  10252. <method name="isReady" return="boolean"
  10253. abstract="false" native="false" synchronized="false"
  10254. static="false" final="false" visibility="public"
  10255. deprecated="not deprecated">
  10256. <doc>
  10257. <![CDATA[@return true if this job is in READY state]]>
  10258. </doc>
  10259. </method>
  10260. <method name="submit"
  10261. abstract="false" native="false" synchronized="true"
  10262. static="false" final="false" visibility="protected"
  10263. deprecated="not deprecated">
  10264. <doc>
  10265. <![CDATA[Submit this job to mapred. The state becomes RUNNING if submission
  10266. is successful, FAILED otherwise.]]>
  10267. </doc>
  10268. </method>
  10269. <field name="SUCCESS" type="int"
  10270. transient="false" volatile="false"
  10271. static="true" final="true" visibility="public"
  10272. deprecated="not deprecated">
  10273. </field>
  10274. <field name="WAITING" type="int"
  10275. transient="false" volatile="false"
  10276. static="true" final="true" visibility="public"
  10277. deprecated="not deprecated">
  10278. </field>
  10279. <field name="RUNNING" type="int"
  10280. transient="false" volatile="false"
  10281. static="true" final="true" visibility="public"
  10282. deprecated="not deprecated">
  10283. </field>
  10284. <field name="READY" type="int"
  10285. transient="false" volatile="false"
  10286. static="true" final="true" visibility="public"
  10287. deprecated="not deprecated">
  10288. </field>
  10289. <field name="FAILED" type="int"
  10290. transient="false" volatile="false"
  10291. static="true" final="true" visibility="public"
  10292. deprecated="not deprecated">
  10293. </field>
  10294. <field name="DEPENDENT_FAILED" type="int"
  10295. transient="false" volatile="false"
  10296. static="true" final="true" visibility="public"
  10297. deprecated="not deprecated">
  10298. </field>
  10299. <doc>
  10300. <![CDATA[This class encapsulates a MapReduce job and its dependency. It monitors
  10301. the states of the depending jobs and updates the state of this job.
  10302. A job starts in the WAITING state. If it does not have any depending jobs, or
  10303. all of the depending jobs are in SUCCESS state, then the job state will become
  10304. READY. If any depending jobs fail, the job will fail too.
  10305. When in READY state, the job can be submitted to Hadoop for execution, with
  10306. the state changing into RUNNING state. From RUNNING state, the job can get into
  10307. SUCCESS or FAILED state, depending the status of the job execution.]]>
  10308. </doc>
  10309. </class>
  10310. <!-- end class org.apache.hadoop.mapred.jobcontrol.Job -->
  10311. <!-- start class org.apache.hadoop.mapred.jobcontrol.JobControl -->
  10312. <class name="JobControl" extends="java.lang.Object"
  10313. abstract="false"
  10314. static="false" final="false" visibility="public"
  10315. deprecated="not deprecated">
  10316. <implements name="java.lang.Runnable"/>
  10317. <constructor name="JobControl" type="java.lang.String"
  10318. static="false" final="false" visibility="public"
  10319. deprecated="not deprecated">
  10320. <doc>
  10321. <![CDATA[Construct a job control for a group of jobs.
  10322. @param groupName a name identifying this group]]>
  10323. </doc>
  10324. </constructor>
  10325. <method name="getWaitingJobs" return="java.util.ArrayList"
  10326. abstract="false" native="false" synchronized="false"
  10327. static="false" final="false" visibility="public"
  10328. deprecated="not deprecated">
  10329. <doc>
  10330. <![CDATA[@return the jobs in the waiting state]]>
  10331. </doc>
  10332. </method>
  10333. <method name="getRunningJobs" return="java.util.ArrayList"
  10334. abstract="false" native="false" synchronized="false"
  10335. static="false" final="false" visibility="public"
  10336. deprecated="not deprecated">
  10337. <doc>
  10338. <![CDATA[@return the jobs in the running state]]>
  10339. </doc>
  10340. </method>
  10341. <method name="getReadyJobs" return="java.util.ArrayList"
  10342. abstract="false" native="false" synchronized="false"
  10343. static="false" final="false" visibility="public"
  10344. deprecated="not deprecated">
  10345. <doc>
  10346. <![CDATA[@return the jobs in the ready state]]>
  10347. </doc>
  10348. </method>
  10349. <method name="getSuccessfulJobs" return="java.util.ArrayList"
  10350. abstract="false" native="false" synchronized="false"
  10351. static="false" final="false" visibility="public"
  10352. deprecated="not deprecated">
  10353. <doc>
  10354. <![CDATA[@return the jobs in the success state]]>
  10355. </doc>
  10356. </method>
  10357. <method name="getFailedJobs" return="java.util.ArrayList"
  10358. abstract="false" native="false" synchronized="false"
  10359. static="false" final="false" visibility="public"
  10360. deprecated="not deprecated">
  10361. </method>
  10362. <method name="addJob" return="java.lang.String"
  10363. abstract="false" native="false" synchronized="true"
  10364. static="false" final="false" visibility="public"
  10365. deprecated="not deprecated">
  10366. <param name="aJob" type="org.apache.hadoop.mapred.jobcontrol.Job"/>
  10367. <doc>
  10368. <![CDATA[Add a new job.
  10369. @param aJob the new job]]>
  10370. </doc>
  10371. </method>
  10372. <method name="addJobs"
  10373. abstract="false" native="false" synchronized="false"
  10374. static="false" final="false" visibility="public"
  10375. deprecated="not deprecated">
  10376. <param name="jobs" type="java.util.Collection"/>
  10377. <doc>
  10378. <![CDATA[Add a collection of jobs
  10379. @param jobs]]>
  10380. </doc>
  10381. </method>
  10382. <method name="getState" return="int"
  10383. abstract="false" native="false" synchronized="false"
  10384. static="false" final="false" visibility="public"
  10385. deprecated="not deprecated">
  10386. <doc>
  10387. <![CDATA[@return the thread state]]>
  10388. </doc>
  10389. </method>
  10390. <method name="stop"
  10391. abstract="false" native="false" synchronized="false"
  10392. static="false" final="false" visibility="public"
  10393. deprecated="not deprecated">
  10394. <doc>
  10395. <![CDATA[set the thread state to STOPPING so that the
  10396. thread will stop when it wakes up.]]>
  10397. </doc>
  10398. </method>
  10399. <method name="suspend"
  10400. abstract="false" native="false" synchronized="false"
  10401. static="false" final="false" visibility="public"
  10402. deprecated="not deprecated">
  10403. <doc>
  10404. <![CDATA[suspend the running thread]]>
  10405. </doc>
  10406. </method>
  10407. <method name="resume"
  10408. abstract="false" native="false" synchronized="false"
  10409. static="false" final="false" visibility="public"
  10410. deprecated="not deprecated">
  10411. <doc>
  10412. <![CDATA[resume the suspended thread]]>
  10413. </doc>
  10414. </method>
  10415. <method name="allFinished" return="boolean"
  10416. abstract="false" native="false" synchronized="true"
  10417. static="false" final="false" visibility="public"
  10418. deprecated="not deprecated">
  10419. </method>
  10420. <method name="run"
  10421. abstract="false" native="false" synchronized="false"
  10422. static="false" final="false" visibility="public"
  10423. deprecated="not deprecated">
  10424. <doc>
  10425. <![CDATA[The main loop for the thread.
  10426. The loop does the following:
  10427. Check the states of the running jobs
  10428. Update the states of waiting jobs
  10429. Submit the jobs in ready state]]>
  10430. </doc>
  10431. </method>
  10432. <doc>
  10433. <![CDATA[This class encapsulates a set of MapReduce jobs and its dependency. It tracks
  10434. the states of the jobs by placing them into different tables according to their
  10435. states.
  10436. This class provides APIs for the client app to add a job to the group and to get
  10437. the jobs in the group in different states. When a
  10438. job is added, an ID unique to the group is assigned to the job.
  10439. This class has a thread that submits jobs when they become ready, monitors the
  10440. states of the running jobs, and updates the states of jobs based on the state changes
  10441. of their depending jobs states. The class provides APIs for suspending/resuming
  10442. the thread,and for stopping the thread.]]>
  10443. </doc>
  10444. </class>
  10445. <!-- end class org.apache.hadoop.mapred.jobcontrol.JobControl -->
  10446. </package>
  10447. <package name="org.apache.hadoop.mapred.join">
  10448. <!-- start class org.apache.hadoop.mapred.join.ArrayListBackedIterator -->
  10449. <class name="ArrayListBackedIterator" extends="java.lang.Object"
  10450. abstract="false"
  10451. static="false" final="false" visibility="public"
  10452. deprecated="not deprecated">
  10453. <implements name="org.apache.hadoop.mapred.join.ResetableIterator"/>
  10454. <constructor name="ArrayListBackedIterator"
  10455. static="false" final="false" visibility="public"
  10456. deprecated="not deprecated">
  10457. </constructor>
  10458. <constructor name="ArrayListBackedIterator" type="java.util.ArrayList"
  10459. static="false" final="false" visibility="public"
  10460. deprecated="not deprecated">
  10461. </constructor>
  10462. <method name="hasNext" return="boolean"
  10463. abstract="false" native="false" synchronized="false"
  10464. static="false" final="false" visibility="public"
  10465. deprecated="not deprecated">
  10466. </method>
  10467. <method name="next" return="boolean"
  10468. abstract="false" native="false" synchronized="false"
  10469. static="false" final="false" visibility="public"
  10470. deprecated="not deprecated">
  10471. <param name="val" type="org.apache.hadoop.io.Writable"/>
  10472. <exception name="IOException" type="java.io.IOException"/>
  10473. </method>
  10474. <method name="replay" return="boolean"
  10475. abstract="false" native="false" synchronized="false"
  10476. static="false" final="false" visibility="public"
  10477. deprecated="not deprecated">
  10478. <param name="val" type="org.apache.hadoop.io.Writable"/>
  10479. <exception name="IOException" type="java.io.IOException"/>
  10480. </method>
  10481. <method name="reset"
  10482. abstract="false" native="false" synchronized="false"
  10483. static="false" final="false" visibility="public"
  10484. deprecated="not deprecated">
  10485. </method>
  10486. <method name="add"
  10487. abstract="false" native="false" synchronized="false"
  10488. static="false" final="false" visibility="public"
  10489. deprecated="not deprecated">
  10490. <param name="item" type="org.apache.hadoop.io.Writable"/>
  10491. <exception name="IOException" type="java.io.IOException"/>
  10492. </method>
  10493. <method name="close"
  10494. abstract="false" native="false" synchronized="false"
  10495. static="false" final="false" visibility="public"
  10496. deprecated="not deprecated">
  10497. <exception name="IOException" type="java.io.IOException"/>
  10498. </method>
  10499. <method name="clear"
  10500. abstract="false" native="false" synchronized="false"
  10501. static="false" final="false" visibility="public"
  10502. deprecated="not deprecated">
  10503. </method>
  10504. <doc>
  10505. <![CDATA[This class provides an implementation of ResetableIterator. The
  10506. implementation uses an {@link java.util.ArrayList} to store elements
  10507. added to it, replaying them as requested.
  10508. Prefer {@link StreamBackedIterator}.]]>
  10509. </doc>
  10510. </class>
  10511. <!-- end class org.apache.hadoop.mapred.join.ArrayListBackedIterator -->
  10512. <!-- start interface org.apache.hadoop.mapred.join.ComposableInputFormat -->
  10513. <interface name="ComposableInputFormat" abstract="true"
  10514. static="false" final="false" visibility="public"
  10515. deprecated="not deprecated">
  10516. <implements name="org.apache.hadoop.mapred.InputFormat"/>
  10517. <method name="getRecordReader" return="org.apache.hadoop.mapred.join.ComposableRecordReader"
  10518. abstract="false" native="false" synchronized="false"
  10519. static="false" final="false" visibility="public"
  10520. deprecated="not deprecated">
  10521. <param name="split" type="org.apache.hadoop.mapred.InputSplit"/>
  10522. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  10523. <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
  10524. <exception name="IOException" type="java.io.IOException"/>
  10525. </method>
  10526. <doc>
  10527. <![CDATA[Refinement of InputFormat requiring implementors to provide
  10528. ComposableRecordReader instead of RecordReader.]]>
  10529. </doc>
  10530. </interface>
  10531. <!-- end interface org.apache.hadoop.mapred.join.ComposableInputFormat -->
  10532. <!-- start interface org.apache.hadoop.mapred.join.ComposableRecordReader -->
  10533. <interface name="ComposableRecordReader" abstract="true"
  10534. static="false" final="false" visibility="public"
  10535. deprecated="not deprecated">
  10536. <implements name="org.apache.hadoop.mapred.RecordReader"/>
  10537. <implements name="java.lang.Comparable"/>
  10538. <method name="id" return="int"
  10539. abstract="false" native="false" synchronized="false"
  10540. static="false" final="false" visibility="public"
  10541. deprecated="not deprecated">
  10542. <doc>
  10543. <![CDATA[Return the position in the collector this class occupies.]]>
  10544. </doc>
  10545. </method>
  10546. <method name="key" return="org.apache.hadoop.io.WritableComparable"
  10547. abstract="false" native="false" synchronized="false"
  10548. static="false" final="false" visibility="public"
  10549. deprecated="not deprecated">
  10550. <doc>
  10551. <![CDATA[Return the key this RecordReader would supply on a call to next(K,V)]]>
  10552. </doc>
  10553. </method>
  10554. <method name="key"
  10555. abstract="false" native="false" synchronized="false"
  10556. static="false" final="false" visibility="public"
  10557. deprecated="not deprecated">
  10558. <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
  10559. <exception name="IOException" type="java.io.IOException"/>
  10560. <doc>
  10561. <![CDATA[Clone the key at the head of this RecordReader into the object provided.]]>
  10562. </doc>
  10563. </method>
  10564. <method name="hasNext" return="boolean"
  10565. abstract="false" native="false" synchronized="false"
  10566. static="false" final="false" visibility="public"
  10567. deprecated="not deprecated">
  10568. <doc>
  10569. <![CDATA[Returns true if the stream is not empty, but provides no guarantee that
  10570. a call to next(K,V) will succeed.]]>
  10571. </doc>
  10572. </method>
  10573. <method name="skip"
  10574. abstract="false" native="false" synchronized="false"
  10575. static="false" final="false" visibility="public"
  10576. deprecated="not deprecated">
  10577. <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
  10578. <exception name="IOException" type="java.io.IOException"/>
  10579. <doc>
  10580. <![CDATA[Skip key-value pairs with keys less than or equal to the key provided.]]>
  10581. </doc>
  10582. </method>
  10583. <method name="accept"
  10584. abstract="false" native="false" synchronized="false"
  10585. static="false" final="false" visibility="public"
  10586. deprecated="not deprecated">
  10587. <param name="jc" type="org.apache.hadoop.mapred.join.CompositeRecordReader.JoinCollector"/>
  10588. <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
  10589. <exception name="IOException" type="java.io.IOException"/>
  10590. <doc>
  10591. <![CDATA[While key-value pairs from this RecordReader match the given key, register
  10592. them with the JoinCollector provided.]]>
  10593. </doc>
  10594. </method>
  10595. <doc>
  10596. <![CDATA[Additional operations required of a RecordReader to participate in a join.]]>
  10597. </doc>
  10598. </interface>
  10599. <!-- end interface org.apache.hadoop.mapred.join.ComposableRecordReader -->
  10600. <!-- start class org.apache.hadoop.mapred.join.CompositeInputFormat -->
  10601. <class name="CompositeInputFormat" extends="java.lang.Object"
  10602. abstract="false"
  10603. static="false" final="false" visibility="public"
  10604. deprecated="not deprecated">
  10605. <implements name="org.apache.hadoop.mapred.join.ComposableInputFormat"/>
  10606. <constructor name="CompositeInputFormat"
  10607. static="false" final="false" visibility="public"
  10608. deprecated="not deprecated">
  10609. </constructor>
  10610. <method name="setFormat"
  10611. abstract="false" native="false" synchronized="false"
  10612. static="false" final="false" visibility="public"
  10613. deprecated="not deprecated">
  10614. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  10615. <exception name="IOException" type="java.io.IOException"/>
  10616. <doc>
  10617. <![CDATA[Interpret a given string as a composite expression.
  10618. {@code
  10619. func ::= <ident>([<func>,]*<func>)
  10620. func ::= tbl(<class>,"<path>")
  10621. class ::= @see java.lang.Class#forName(java.lang.String)
  10622. path ::= @see org.apache.hadoop.fs.Path#Path(java.lang.String)
  10623. }
  10624. Reads expression from the <tt>mapred.join.expr</tt> property and
  10625. user-supplied join types from <tt>mapred.join.define.&lt;ident&gt;</tt>
  10626. types. Paths supplied to <tt>tbl</tt> are given as input paths to the
  10627. InputFormat class listed.
  10628. @see #compose(java.lang.String, java.lang.Class, java.lang.String...)]]>
  10629. </doc>
  10630. </method>
  10631. <method name="addDefaults"
  10632. abstract="false" native="false" synchronized="false"
  10633. static="false" final="false" visibility="protected"
  10634. deprecated="not deprecated">
  10635. <doc>
  10636. <![CDATA[Adds the default set of identifiers to the parser.]]>
  10637. </doc>
  10638. </method>
  10639. <method name="getSplits" return="org.apache.hadoop.mapred.InputSplit[]"
  10640. abstract="false" native="false" synchronized="false"
  10641. static="false" final="false" visibility="public"
  10642. deprecated="not deprecated">
  10643. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  10644. <param name="numSplits" type="int"/>
  10645. <exception name="IOException" type="java.io.IOException"/>
  10646. <doc>
  10647. <![CDATA[Build a CompositeInputSplit from the child InputFormats by assigning the
  10648. ith split from each child to the ith composite split.]]>
  10649. </doc>
  10650. </method>
  10651. <method name="getRecordReader" return="org.apache.hadoop.mapred.join.ComposableRecordReader"
  10652. abstract="false" native="false" synchronized="false"
  10653. static="false" final="false" visibility="public"
  10654. deprecated="not deprecated">
  10655. <param name="split" type="org.apache.hadoop.mapred.InputSplit"/>
  10656. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  10657. <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
  10658. <exception name="IOException" type="java.io.IOException"/>
  10659. <doc>
  10660. <![CDATA[Construct a CompositeRecordReader for the children of this InputFormat
  10661. as defined in the init expression.
  10662. The outermost join need only be composable, not necessarily a composite.
  10663. Mandating TupleWritable isn't strictly correct.]]>
  10664. </doc>
  10665. </method>
  10666. <method name="compose" return="java.lang.String"
  10667. abstract="false" native="false" synchronized="false"
  10668. static="true" final="false" visibility="public"
  10669. deprecated="not deprecated">
  10670. <param name="inf" type="java.lang.Class"/>
  10671. <param name="path" type="java.lang.String"/>
  10672. <doc>
  10673. <![CDATA[Convenience method for constructing composite formats.
  10674. Given InputFormat class (inf), path (p) return:
  10675. {@code tbl(<inf>, <p>) }]]>
  10676. </doc>
  10677. </method>
  10678. <method name="compose" return="java.lang.String"
  10679. abstract="false" native="false" synchronized="false"
  10680. static="true" final="false" visibility="public"
  10681. deprecated="not deprecated">
  10682. <param name="op" type="java.lang.String"/>
  10683. <param name="inf" type="java.lang.Class"/>
  10684. <param name="path" type="java.lang.String[]"/>
  10685. <doc>
  10686. <![CDATA[Convenience method for constructing composite formats.
  10687. Given operation (op), Object class (inf), set of paths (p) return:
  10688. {@code <op>(tbl(<inf>,<p1>),tbl(<inf>,<p2>),...,tbl(<inf>,<pn>)) }]]>
  10689. </doc>
  10690. </method>
  10691. <method name="compose" return="java.lang.String"
  10692. abstract="false" native="false" synchronized="false"
  10693. static="true" final="false" visibility="public"
  10694. deprecated="not deprecated">
  10695. <param name="op" type="java.lang.String"/>
  10696. <param name="inf" type="java.lang.Class"/>
  10697. <param name="path" type="org.apache.hadoop.fs.Path[]"/>
  10698. <doc>
  10699. <![CDATA[Convenience method for constructing composite formats.
  10700. Given operation (op), Object class (inf), set of paths (p) return:
  10701. {@code <op>(tbl(<inf>,<p1>),tbl(<inf>,<p2>),...,tbl(<inf>,<pn>)) }]]>
  10702. </doc>
  10703. </method>
  10704. <doc>
  10705. <![CDATA[An InputFormat capable of performing joins over a set of data sources sorted
  10706. and partitioned the same way.
  10707. @see #setFormat
  10708. A user may define new join types by setting the property
  10709. <tt>mapred.join.define.&lt;ident&gt;</tt> to a classname. In the expression
  10710. <tt>mapred.join.expr</tt>, the identifier will be assumed to be a
  10711. ComposableRecordReader.
  10712. <tt>mapred.join.keycomparator</tt> can be a classname used to compare keys
  10713. in the join.
  10714. @see JoinRecordReader
  10715. @see MultiFilterRecordReader]]>
  10716. </doc>
  10717. </class>
  10718. <!-- end class org.apache.hadoop.mapred.join.CompositeInputFormat -->
  10719. <!-- start class org.apache.hadoop.mapred.join.CompositeInputSplit -->
  10720. <class name="CompositeInputSplit" extends="java.lang.Object"
  10721. abstract="false"
  10722. static="false" final="false" visibility="public"
  10723. deprecated="not deprecated">
  10724. <implements name="org.apache.hadoop.mapred.InputSplit"/>
  10725. <constructor name="CompositeInputSplit"
  10726. static="false" final="false" visibility="public"
  10727. deprecated="not deprecated">
  10728. </constructor>
  10729. <constructor name="CompositeInputSplit" type="int"
  10730. static="false" final="false" visibility="public"
  10731. deprecated="not deprecated">
  10732. </constructor>
  10733. <method name="add"
  10734. abstract="false" native="false" synchronized="false"
  10735. static="false" final="false" visibility="public"
  10736. deprecated="not deprecated">
  10737. <param name="s" type="org.apache.hadoop.mapred.InputSplit"/>
  10738. <exception name="IOException" type="java.io.IOException"/>
  10739. <doc>
  10740. <![CDATA[Add an InputSplit to this collection.
  10741. @throws IOException If capacity was not specified during construction
  10742. or if capacity has been reached.]]>
  10743. </doc>
  10744. </method>
  10745. <method name="get" return="org.apache.hadoop.mapred.InputSplit"
  10746. abstract="false" native="false" synchronized="false"
  10747. static="false" final="false" visibility="public"
  10748. deprecated="not deprecated">
  10749. <param name="i" type="int"/>
  10750. <doc>
  10751. <![CDATA[Get ith child InputSplit.]]>
  10752. </doc>
  10753. </method>
  10754. <method name="getLength" return="long"
  10755. abstract="false" native="false" synchronized="false"
  10756. static="false" final="false" visibility="public"
  10757. deprecated="not deprecated">
  10758. <exception name="IOException" type="java.io.IOException"/>
  10759. <doc>
  10760. <![CDATA[Return the aggregate length of all child InputSplits currently added.]]>
  10761. </doc>
  10762. </method>
  10763. <method name="getLength" return="long"
  10764. abstract="false" native="false" synchronized="false"
  10765. static="false" final="false" visibility="public"
  10766. deprecated="not deprecated">
  10767. <param name="i" type="int"/>
  10768. <exception name="IOException" type="java.io.IOException"/>
  10769. <doc>
  10770. <![CDATA[Get the length of ith child InputSplit.]]>
  10771. </doc>
  10772. </method>
  10773. <method name="getLocations" return="java.lang.String[]"
  10774. abstract="false" native="false" synchronized="false"
  10775. static="false" final="false" visibility="public"
  10776. deprecated="not deprecated">
  10777. <exception name="IOException" type="java.io.IOException"/>
  10778. <doc>
  10779. <![CDATA[Collect a set of hosts from all child InputSplits.]]>
  10780. </doc>
  10781. </method>
  10782. <method name="getLocation" return="java.lang.String[]"
  10783. abstract="false" native="false" synchronized="false"
  10784. static="false" final="false" visibility="public"
  10785. deprecated="not deprecated">
  10786. <param name="i" type="int"/>
  10787. <exception name="IOException" type="java.io.IOException"/>
  10788. <doc>
  10789. <![CDATA[getLocations from ith InputSplit.]]>
  10790. </doc>
  10791. </method>
  10792. <method name="write"
  10793. abstract="false" native="false" synchronized="false"
  10794. static="false" final="false" visibility="public"
  10795. deprecated="not deprecated">
  10796. <param name="out" type="java.io.DataOutput"/>
  10797. <exception name="IOException" type="java.io.IOException"/>
  10798. <doc>
  10799. <![CDATA[Write splits in the following format.
  10800. {@code
  10801. <count><class1><class2>...<classn><split1><split2>...<splitn>
  10802. }]]>
  10803. </doc>
  10804. </method>
  10805. <method name="readFields"
  10806. abstract="false" native="false" synchronized="false"
  10807. static="false" final="false" visibility="public"
  10808. deprecated="not deprecated">
  10809. <param name="in" type="java.io.DataInput"/>
  10810. <exception name="IOException" type="java.io.IOException"/>
  10811. <doc>
  10812. <![CDATA[{@inheritDoc}
  10813. @throws IOException If the child InputSplit cannot be read, typically
  10814. for faliing access checks.]]>
  10815. </doc>
  10816. </method>
  10817. <doc>
  10818. <![CDATA[This InputSplit contains a set of child InputSplits. Any InputSplit inserted
  10819. into this collection must have a public default constructor.]]>
  10820. </doc>
  10821. </class>
  10822. <!-- end class org.apache.hadoop.mapred.join.CompositeInputSplit -->
  10823. <!-- start class org.apache.hadoop.mapred.join.CompositeRecordReader -->
  10824. <class name="CompositeRecordReader" extends="java.lang.Object"
  10825. abstract="true"
  10826. static="false" final="false" visibility="public"
  10827. deprecated="not deprecated">
  10828. <implements name="org.apache.hadoop.conf.Configurable"/>
  10829. <constructor name="CompositeRecordReader" type="int, int, java.lang.Class"
  10830. static="false" final="false" visibility="public"
  10831. deprecated="not deprecated">
  10832. <exception name="IOException" type="java.io.IOException"/>
  10833. <doc>
  10834. <![CDATA[Create a RecordReader with <tt>capacity</tt> children to position
  10835. <tt>id</tt> in the parent reader.
  10836. The id of a root CompositeRecordReader is -1 by convention, but relying
  10837. on this is not recommended.]]>
  10838. </doc>
  10839. </constructor>
  10840. <method name="combine" return="boolean"
  10841. abstract="true" native="false" synchronized="false"
  10842. static="false" final="false" visibility="protected"
  10843. deprecated="not deprecated">
  10844. <param name="srcs" type="java.lang.Object[]"/>
  10845. <param name="value" type="org.apache.hadoop.mapred.join.TupleWritable"/>
  10846. </method>
  10847. <method name="id" return="int"
  10848. abstract="false" native="false" synchronized="false"
  10849. static="false" final="false" visibility="public"
  10850. deprecated="not deprecated">
  10851. <doc>
  10852. <![CDATA[Return the position in the collector this class occupies.]]>
  10853. </doc>
  10854. </method>
  10855. <method name="setConf"
  10856. abstract="false" native="false" synchronized="false"
  10857. static="false" final="false" visibility="public"
  10858. deprecated="not deprecated">
  10859. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  10860. <doc>
  10861. <![CDATA[{@inheritDoc}]]>
  10862. </doc>
  10863. </method>
  10864. <method name="getConf" return="org.apache.hadoop.conf.Configuration"
  10865. abstract="false" native="false" synchronized="false"
  10866. static="false" final="false" visibility="public"
  10867. deprecated="not deprecated">
  10868. <doc>
  10869. <![CDATA[{@inheritDoc}]]>
  10870. </doc>
  10871. </method>
  10872. <method name="getRecordReaderQueue" return="java.util.PriorityQueue"
  10873. abstract="false" native="false" synchronized="false"
  10874. static="false" final="false" visibility="protected"
  10875. deprecated="not deprecated">
  10876. <doc>
  10877. <![CDATA[Return sorted list of RecordReaders for this composite.]]>
  10878. </doc>
  10879. </method>
  10880. <method name="getComparator" return="org.apache.hadoop.io.WritableComparator"
  10881. abstract="false" native="false" synchronized="false"
  10882. static="false" final="false" visibility="protected"
  10883. deprecated="not deprecated">
  10884. <doc>
  10885. <![CDATA[Return comparator defining the ordering for RecordReaders in this
  10886. composite.]]>
  10887. </doc>
  10888. </method>
  10889. <method name="add"
  10890. abstract="false" native="false" synchronized="false"
  10891. static="false" final="false" visibility="public"
  10892. deprecated="not deprecated">
  10893. <param name="rr" type="org.apache.hadoop.mapred.join.ComposableRecordReader"/>
  10894. <exception name="IOException" type="java.io.IOException"/>
  10895. <doc>
  10896. <![CDATA[Add a RecordReader to this collection.
  10897. The id() of a RecordReader determines where in the Tuple its
  10898. entry will appear. Adding RecordReaders with the same id has
  10899. undefined behavior.]]>
  10900. </doc>
  10901. </method>
  10902. <method name="key" return="org.apache.hadoop.io.WritableComparable"
  10903. abstract="false" native="false" synchronized="false"
  10904. static="false" final="false" visibility="public"
  10905. deprecated="not deprecated">
  10906. <doc>
  10907. <![CDATA[Return the key for the current join or the value at the top of the
  10908. RecordReader heap.]]>
  10909. </doc>
  10910. </method>
  10911. <method name="key"
  10912. abstract="false" native="false" synchronized="false"
  10913. static="false" final="false" visibility="public"
  10914. deprecated="not deprecated">
  10915. <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
  10916. <exception name="IOException" type="java.io.IOException"/>
  10917. <doc>
  10918. <![CDATA[Clone the key at the top of this RR into the given object.]]>
  10919. </doc>
  10920. </method>
  10921. <method name="hasNext" return="boolean"
  10922. abstract="false" native="false" synchronized="false"
  10923. static="false" final="false" visibility="public"
  10924. deprecated="not deprecated">
  10925. <doc>
  10926. <![CDATA[Return true if it is possible that this could emit more values.]]>
  10927. </doc>
  10928. </method>
  10929. <method name="skip"
  10930. abstract="false" native="false" synchronized="false"
  10931. static="false" final="false" visibility="public"
  10932. deprecated="not deprecated">
  10933. <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
  10934. <exception name="IOException" type="java.io.IOException"/>
  10935. <doc>
  10936. <![CDATA[Pass skip key to child RRs.]]>
  10937. </doc>
  10938. </method>
  10939. <method name="getDelegate" return="org.apache.hadoop.mapred.join.ResetableIterator"
  10940. abstract="true" native="false" synchronized="false"
  10941. static="false" final="false" visibility="protected"
  10942. deprecated="not deprecated">
  10943. <doc>
  10944. <![CDATA[Obtain an iterator over the child RRs apropos of the value type
  10945. ultimately emitted from this join.]]>
  10946. </doc>
  10947. </method>
  10948. <method name="accept"
  10949. abstract="false" native="false" synchronized="false"
  10950. static="false" final="false" visibility="public"
  10951. deprecated="not deprecated">
  10952. <param name="jc" type="org.apache.hadoop.mapred.join.CompositeRecordReader.JoinCollector"/>
  10953. <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
  10954. <exception name="IOException" type="java.io.IOException"/>
  10955. <doc>
  10956. <![CDATA[If key provided matches that of this Composite, give JoinCollector
  10957. iterator over values it may emit.]]>
  10958. </doc>
  10959. </method>
  10960. <method name="fillJoinCollector"
  10961. abstract="false" native="false" synchronized="false"
  10962. static="false" final="false" visibility="protected"
  10963. deprecated="not deprecated">
  10964. <param name="iterkey" type="org.apache.hadoop.io.WritableComparable"/>
  10965. <exception name="IOException" type="java.io.IOException"/>
  10966. <doc>
  10967. <![CDATA[For all child RRs offering the key provided, obtain an iterator
  10968. at that position in the JoinCollector.]]>
  10969. </doc>
  10970. </method>
  10971. <method name="compareTo" return="int"
  10972. abstract="false" native="false" synchronized="false"
  10973. static="false" final="false" visibility="public"
  10974. deprecated="not deprecated">
  10975. <param name="other" type="org.apache.hadoop.mapred.join.ComposableRecordReader"/>
  10976. <doc>
  10977. <![CDATA[Implement Comparable contract (compare key of join or head of heap
  10978. with that of another).]]>
  10979. </doc>
  10980. </method>
  10981. <method name="createKey" return="org.apache.hadoop.io.WritableComparable"
  10982. abstract="false" native="false" synchronized="false"
  10983. static="false" final="false" visibility="public"
  10984. deprecated="not deprecated">
  10985. <doc>
  10986. <![CDATA[Create a new key value common to all child RRs.
  10987. @throws ClassCastException if key classes differ.]]>
  10988. </doc>
  10989. </method>
  10990. <method name="createInternalValue" return="org.apache.hadoop.mapred.join.TupleWritable"
  10991. abstract="false" native="false" synchronized="false"
  10992. static="false" final="false" visibility="protected"
  10993. deprecated="not deprecated">
  10994. <doc>
  10995. <![CDATA[Create a value to be used internally for joins.]]>
  10996. </doc>
  10997. </method>
  10998. <method name="getPos" return="long"
  10999. abstract="false" native="false" synchronized="false"
  11000. static="false" final="false" visibility="public"
  11001. deprecated="not deprecated">
  11002. <exception name="IOException" type="java.io.IOException"/>
  11003. <doc>
  11004. <![CDATA[Unsupported (returns zero in all cases).]]>
  11005. </doc>
  11006. </method>
  11007. <method name="close"
  11008. abstract="false" native="false" synchronized="false"
  11009. static="false" final="false" visibility="public"
  11010. deprecated="not deprecated">
  11011. <exception name="IOException" type="java.io.IOException"/>
  11012. <doc>
  11013. <![CDATA[Close all child RRs.]]>
  11014. </doc>
  11015. </method>
  11016. <method name="getProgress" return="float"
  11017. abstract="false" native="false" synchronized="false"
  11018. static="false" final="false" visibility="public"
  11019. deprecated="not deprecated">
  11020. <exception name="IOException" type="java.io.IOException"/>
  11021. <doc>
  11022. <![CDATA[Report progress as the minimum of all child RR progress.]]>
  11023. </doc>
  11024. </method>
  11025. <field name="jc" type="org.apache.hadoop.mapred.join.CompositeRecordReader.JoinCollector"
  11026. transient="false" volatile="false"
  11027. static="false" final="true" visibility="protected"
  11028. deprecated="not deprecated">
  11029. </field>
  11030. <field name="kids" type="org.apache.hadoop.mapred.join.ComposableRecordReader[]"
  11031. transient="false" volatile="false"
  11032. static="false" final="true" visibility="protected"
  11033. deprecated="not deprecated">
  11034. </field>
  11035. <doc>
  11036. <![CDATA[A RecordReader that can effect joins of RecordReaders sharing a common key
  11037. type and partitioning.]]>
  11038. </doc>
  11039. </class>
  11040. <!-- end class org.apache.hadoop.mapred.join.CompositeRecordReader -->
  11041. <!-- start class org.apache.hadoop.mapred.join.InnerJoinRecordReader -->
  11042. <class name="InnerJoinRecordReader" extends="org.apache.hadoop.mapred.join.JoinRecordReader"
  11043. abstract="false"
  11044. static="false" final="false" visibility="public"
  11045. deprecated="not deprecated">
  11046. <method name="combine" return="boolean"
  11047. abstract="false" native="false" synchronized="false"
  11048. static="false" final="false" visibility="protected"
  11049. deprecated="not deprecated">
  11050. <param name="srcs" type="java.lang.Object[]"/>
  11051. <param name="dst" type="org.apache.hadoop.mapred.join.TupleWritable"/>
  11052. <doc>
  11053. <![CDATA[Return true iff the tuple is full (all data sources contain this key).]]>
  11054. </doc>
  11055. </method>
  11056. <doc>
  11057. <![CDATA[Full inner join.]]>
  11058. </doc>
  11059. </class>
  11060. <!-- end class org.apache.hadoop.mapred.join.InnerJoinRecordReader -->
  11061. <!-- start class org.apache.hadoop.mapred.join.JoinRecordReader -->
  11062. <class name="JoinRecordReader" extends="org.apache.hadoop.mapred.join.CompositeRecordReader"
  11063. abstract="true"
  11064. static="false" final="false" visibility="public"
  11065. deprecated="not deprecated">
  11066. <implements name="org.apache.hadoop.mapred.join.ComposableRecordReader"/>
  11067. <constructor name="JoinRecordReader" type="int, org.apache.hadoop.mapred.JobConf, int, java.lang.Class"
  11068. static="false" final="false" visibility="public"
  11069. deprecated="not deprecated">
  11070. <exception name="IOException" type="java.io.IOException"/>
  11071. </constructor>
  11072. <method name="next" return="boolean"
  11073. abstract="false" native="false" synchronized="false"
  11074. static="false" final="false" visibility="public"
  11075. deprecated="not deprecated">
  11076. <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
  11077. <param name="value" type="org.apache.hadoop.mapred.join.TupleWritable"/>
  11078. <exception name="IOException" type="java.io.IOException"/>
  11079. <doc>
  11080. <![CDATA[Emit the next set of key, value pairs as defined by the child
  11081. RecordReaders and operation associated with this composite RR.]]>
  11082. </doc>
  11083. </method>
  11084. <method name="createValue" return="org.apache.hadoop.mapred.join.TupleWritable"
  11085. abstract="false" native="false" synchronized="false"
  11086. static="false" final="false" visibility="public"
  11087. deprecated="not deprecated">
  11088. <doc>
  11089. <![CDATA[{@inheritDoc}]]>
  11090. </doc>
  11091. </method>
  11092. <method name="getDelegate" return="org.apache.hadoop.mapred.join.ResetableIterator"
  11093. abstract="false" native="false" synchronized="false"
  11094. static="false" final="false" visibility="protected"
  11095. deprecated="not deprecated">
  11096. <doc>
  11097. <![CDATA[Return an iterator wrapping the JoinCollector.]]>
  11098. </doc>
  11099. </method>
  11100. <doc>
  11101. <![CDATA[Base class for Composite joins returning Tuples of arbitrary Writables.]]>
  11102. </doc>
  11103. </class>
  11104. <!-- end class org.apache.hadoop.mapred.join.JoinRecordReader -->
  11105. <!-- start class org.apache.hadoop.mapred.join.JoinRecordReader.JoinDelegationIterator -->
  11106. <class name="JoinRecordReader.JoinDelegationIterator" extends="java.lang.Object"
  11107. abstract="false"
  11108. static="false" final="false" visibility="protected"
  11109. deprecated="not deprecated">
  11110. <implements name="org.apache.hadoop.mapred.join.ResetableIterator"/>
  11111. <constructor name="JoinRecordReader.JoinDelegationIterator"
  11112. static="false" final="false" visibility="protected"
  11113. deprecated="not deprecated">
  11114. </constructor>
  11115. <method name="hasNext" return="boolean"
  11116. abstract="false" native="false" synchronized="false"
  11117. static="false" final="false" visibility="public"
  11118. deprecated="not deprecated">
  11119. </method>
  11120. <method name="next" return="boolean"
  11121. abstract="false" native="false" synchronized="false"
  11122. static="false" final="false" visibility="public"
  11123. deprecated="not deprecated">
  11124. <param name="val" type="org.apache.hadoop.mapred.join.TupleWritable"/>
  11125. <exception name="IOException" type="java.io.IOException"/>
  11126. </method>
  11127. <method name="replay" return="boolean"
  11128. abstract="false" native="false" synchronized="false"
  11129. static="false" final="false" visibility="public"
  11130. deprecated="not deprecated">
  11131. <param name="val" type="org.apache.hadoop.mapred.join.TupleWritable"/>
  11132. <exception name="IOException" type="java.io.IOException"/>
  11133. </method>
  11134. <method name="reset"
  11135. abstract="false" native="false" synchronized="false"
  11136. static="false" final="false" visibility="public"
  11137. deprecated="not deprecated">
  11138. </method>
  11139. <method name="add"
  11140. abstract="false" native="false" synchronized="false"
  11141. static="false" final="false" visibility="public"
  11142. deprecated="not deprecated">
  11143. <param name="item" type="org.apache.hadoop.mapred.join.TupleWritable"/>
  11144. <exception name="IOException" type="java.io.IOException"/>
  11145. </method>
  11146. <method name="close"
  11147. abstract="false" native="false" synchronized="false"
  11148. static="false" final="false" visibility="public"
  11149. deprecated="not deprecated">
  11150. <exception name="IOException" type="java.io.IOException"/>
  11151. </method>
  11152. <method name="clear"
  11153. abstract="false" native="false" synchronized="false"
  11154. static="false" final="false" visibility="public"
  11155. deprecated="not deprecated">
  11156. </method>
  11157. <doc>
  11158. <![CDATA[Since the JoinCollector is effecting our operation, we need only
  11159. provide an iterator proxy wrapping its operation.]]>
  11160. </doc>
  11161. </class>
  11162. <!-- end class org.apache.hadoop.mapred.join.JoinRecordReader.JoinDelegationIterator -->
  11163. <!-- start class org.apache.hadoop.mapred.join.MultiFilterRecordReader -->
  11164. <class name="MultiFilterRecordReader" extends="org.apache.hadoop.mapred.join.CompositeRecordReader"
  11165. abstract="true"
  11166. static="false" final="false" visibility="public"
  11167. deprecated="not deprecated">
  11168. <implements name="org.apache.hadoop.mapred.join.ComposableRecordReader"/>
  11169. <constructor name="MultiFilterRecordReader" type="int, org.apache.hadoop.mapred.JobConf, int, java.lang.Class"
  11170. static="false" final="false" visibility="public"
  11171. deprecated="not deprecated">
  11172. <exception name="IOException" type="java.io.IOException"/>
  11173. </constructor>
  11174. <method name="emit" return="org.apache.hadoop.io.Writable"
  11175. abstract="true" native="false" synchronized="false"
  11176. static="false" final="false" visibility="protected"
  11177. deprecated="not deprecated">
  11178. <param name="dst" type="org.apache.hadoop.mapred.join.TupleWritable"/>
  11179. <exception name="IOException" type="java.io.IOException"/>
  11180. <doc>
  11181. <![CDATA[For each tuple emitted, return a value (typically one of the values
  11182. in the tuple).
  11183. Modifying the Writables in the tuple is permitted and unlikely to affect
  11184. join behavior in most cases, but it is not recommended. It's safer to
  11185. clone first.]]>
  11186. </doc>
  11187. </method>
  11188. <method name="combine" return="boolean"
  11189. abstract="false" native="false" synchronized="false"
  11190. static="false" final="false" visibility="protected"
  11191. deprecated="not deprecated">
  11192. <param name="srcs" type="java.lang.Object[]"/>
  11193. <param name="dst" type="org.apache.hadoop.mapred.join.TupleWritable"/>
  11194. <doc>
  11195. <![CDATA[Default implementation offers {@link #emit} every Tuple from the
  11196. collector (the outer join of child RRs).]]>
  11197. </doc>
  11198. </method>
  11199. <method name="next" return="boolean"
  11200. abstract="false" native="false" synchronized="false"
  11201. static="false" final="false" visibility="public"
  11202. deprecated="not deprecated">
  11203. <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
  11204. <param name="value" type="org.apache.hadoop.io.Writable"/>
  11205. <exception name="IOException" type="java.io.IOException"/>
  11206. <doc>
  11207. <![CDATA[{@inheritDoc}]]>
  11208. </doc>
  11209. </method>
  11210. <method name="createValue" return="org.apache.hadoop.io.Writable"
  11211. abstract="false" native="false" synchronized="false"
  11212. static="false" final="false" visibility="public"
  11213. deprecated="not deprecated">
  11214. <doc>
  11215. <![CDATA[{@inheritDoc}]]>
  11216. </doc>
  11217. </method>
  11218. <method name="getDelegate" return="org.apache.hadoop.mapred.join.ResetableIterator"
  11219. abstract="false" native="false" synchronized="false"
  11220. static="false" final="false" visibility="protected"
  11221. deprecated="not deprecated">
  11222. <doc>
  11223. <![CDATA[Return an iterator returning a single value from the tuple.
  11224. @see MultiFilterDelegationIterator]]>
  11225. </doc>
  11226. </method>
  11227. <doc>
  11228. <![CDATA[Base class for Composite join returning values derived from multiple
  11229. sources, but generally not tuples.]]>
  11230. </doc>
  11231. </class>
  11232. <!-- end class org.apache.hadoop.mapred.join.MultiFilterRecordReader -->
  11233. <!-- start class org.apache.hadoop.mapred.join.MultiFilterRecordReader.MultiFilterDelegationIterator -->
  11234. <class name="MultiFilterRecordReader.MultiFilterDelegationIterator" extends="java.lang.Object"
  11235. abstract="false"
  11236. static="false" final="false" visibility="protected"
  11237. deprecated="not deprecated">
  11238. <implements name="org.apache.hadoop.mapred.join.ResetableIterator"/>
  11239. <constructor name="MultiFilterRecordReader.MultiFilterDelegationIterator"
  11240. static="false" final="false" visibility="protected"
  11241. deprecated="not deprecated">
  11242. </constructor>
  11243. <method name="hasNext" return="boolean"
  11244. abstract="false" native="false" synchronized="false"
  11245. static="false" final="false" visibility="public"
  11246. deprecated="not deprecated">
  11247. </method>
  11248. <method name="next" return="boolean"
  11249. abstract="false" native="false" synchronized="false"
  11250. static="false" final="false" visibility="public"
  11251. deprecated="not deprecated">
  11252. <param name="val" type="org.apache.hadoop.io.Writable"/>
  11253. <exception name="IOException" type="java.io.IOException"/>
  11254. </method>
  11255. <method name="replay" return="boolean"
  11256. abstract="false" native="false" synchronized="false"
  11257. static="false" final="false" visibility="public"
  11258. deprecated="not deprecated">
  11259. <param name="val" type="org.apache.hadoop.io.Writable"/>
  11260. <exception name="IOException" type="java.io.IOException"/>
  11261. </method>
  11262. <method name="reset"
  11263. abstract="false" native="false" synchronized="false"
  11264. static="false" final="false" visibility="public"
  11265. deprecated="not deprecated">
  11266. </method>
  11267. <method name="add"
  11268. abstract="false" native="false" synchronized="false"
  11269. static="false" final="false" visibility="public"
  11270. deprecated="not deprecated">
  11271. <param name="item" type="org.apache.hadoop.io.Writable"/>
  11272. <exception name="IOException" type="java.io.IOException"/>
  11273. </method>
  11274. <method name="close"
  11275. abstract="false" native="false" synchronized="false"
  11276. static="false" final="false" visibility="public"
  11277. deprecated="not deprecated">
  11278. <exception name="IOException" type="java.io.IOException"/>
  11279. </method>
  11280. <method name="clear"
  11281. abstract="false" native="false" synchronized="false"
  11282. static="false" final="false" visibility="public"
  11283. deprecated="not deprecated">
  11284. </method>
  11285. <doc>
  11286. <![CDATA[Proxy the JoinCollector, but include callback to emit.]]>
  11287. </doc>
  11288. </class>
  11289. <!-- end class org.apache.hadoop.mapred.join.MultiFilterRecordReader.MultiFilterDelegationIterator -->
  11290. <!-- start class org.apache.hadoop.mapred.join.OuterJoinRecordReader -->
  11291. <class name="OuterJoinRecordReader" extends="org.apache.hadoop.mapred.join.JoinRecordReader"
  11292. abstract="false"
  11293. static="false" final="false" visibility="public"
  11294. deprecated="not deprecated">
  11295. <method name="combine" return="boolean"
  11296. abstract="false" native="false" synchronized="false"
  11297. static="false" final="false" visibility="protected"
  11298. deprecated="not deprecated">
  11299. <param name="srcs" type="java.lang.Object[]"/>
  11300. <param name="dst" type="org.apache.hadoop.mapred.join.TupleWritable"/>
  11301. <doc>
  11302. <![CDATA[Emit everything from the collector.]]>
  11303. </doc>
  11304. </method>
  11305. <doc>
  11306. <![CDATA[Full outer join.]]>
  11307. </doc>
  11308. </class>
  11309. <!-- end class org.apache.hadoop.mapred.join.OuterJoinRecordReader -->
  11310. <!-- start class org.apache.hadoop.mapred.join.OverrideRecordReader -->
  11311. <class name="OverrideRecordReader" extends="org.apache.hadoop.mapred.join.MultiFilterRecordReader"
  11312. abstract="false"
  11313. static="false" final="false" visibility="public"
  11314. deprecated="not deprecated">
  11315. <method name="emit" return="org.apache.hadoop.io.Writable"
  11316. abstract="false" native="false" synchronized="false"
  11317. static="false" final="false" visibility="protected"
  11318. deprecated="not deprecated">
  11319. <param name="dst" type="org.apache.hadoop.mapred.join.TupleWritable"/>
  11320. <doc>
  11321. <![CDATA[Emit the value with the highest position in the tuple.]]>
  11322. </doc>
  11323. </method>
  11324. <method name="fillJoinCollector"
  11325. abstract="false" native="false" synchronized="false"
  11326. static="false" final="false" visibility="protected"
  11327. deprecated="not deprecated">
  11328. <param name="iterkey" type="org.apache.hadoop.io.WritableComparable"/>
  11329. <exception name="IOException" type="java.io.IOException"/>
  11330. <doc>
  11331. <![CDATA[Instead of filling the JoinCollector with iterators from all
  11332. data sources, fill only the rightmost for this key.
  11333. This not only saves space by discarding the other sources, but
  11334. it also emits the number of key-value pairs in the preferred
  11335. RecordReader instead of repeating that stream n times, where
  11336. n is the cardinality of the cross product of the discarded
  11337. streams for the given key.]]>
  11338. </doc>
  11339. </method>
  11340. <doc>
  11341. <![CDATA[Prefer the &quot;rightmost&quot; data source for this key.
  11342. For example, <tt>override(S1,S2,S3)</tt> will prefer values
  11343. from S3 over S2, and values from S2 over S1 for all keys
  11344. emitted from all sources.]]>
  11345. </doc>
  11346. </class>
  11347. <!-- end class org.apache.hadoop.mapred.join.OverrideRecordReader -->
  11348. <!-- start class org.apache.hadoop.mapred.join.Parser -->
  11349. <class name="Parser" extends="java.lang.Object"
  11350. abstract="false"
  11351. static="false" final="false" visibility="public"
  11352. deprecated="not deprecated">
  11353. <constructor name="Parser"
  11354. static="false" final="false" visibility="public"
  11355. deprecated="not deprecated">
  11356. </constructor>
  11357. <doc>
  11358. <![CDATA[Very simple shift-reduce parser for join expressions.
  11359. This should be sufficient for the user extension permitted now, but ought to
  11360. be replaced with a parser generator if more complex grammars are supported.
  11361. In particular, this &quot;shift-reduce&quot; parser has no states. Each set
  11362. of formals requires a different internal node type, which is responsible for
  11363. interpreting the list of tokens it receives. This is sufficient for the
  11364. current grammar, but it has several annoying properties that might inhibit
  11365. extension. In particular, parenthesis are always function calls; an
  11366. algebraic or filter grammar would not only require a node type, but must
  11367. also work around the internals of this parser.
  11368. For most other cases, adding classes to the hierarchy- particularly by
  11369. extending JoinRecordReader and MultiFilterRecordReader- is fairly
  11370. straightforward. One need only override the relevant method(s) (usually only
  11371. {@link CompositeRecordReader#combine}) and include a property to map its
  11372. value to an identifier in the parser.]]>
  11373. </doc>
  11374. </class>
  11375. <!-- end class org.apache.hadoop.mapred.join.Parser -->
  11376. <!-- start class org.apache.hadoop.mapred.join.Parser.Node -->
  11377. <class name="Parser.Node" extends="java.lang.Object"
  11378. abstract="true"
  11379. static="true" final="false" visibility="public"
  11380. deprecated="not deprecated">
  11381. <implements name="org.apache.hadoop.mapred.join.ComposableInputFormat"/>
  11382. <constructor name="Parser.Node" type="java.lang.String"
  11383. static="false" final="false" visibility="protected"
  11384. deprecated="not deprecated">
  11385. </constructor>
  11386. <method name="addIdentifier"
  11387. abstract="false" native="false" synchronized="false"
  11388. static="true" final="false" visibility="protected"
  11389. deprecated="not deprecated">
  11390. <param name="ident" type="java.lang.String"/>
  11391. <param name="mcstrSig" type="java.lang.Class[]"/>
  11392. <param name="nodetype" type="java.lang.Class"/>
  11393. <param name="cl" type="java.lang.Class"/>
  11394. <exception name="NoSuchMethodException" type="java.lang.NoSuchMethodException"/>
  11395. <doc>
  11396. <![CDATA[For a given identifier, add a mapping to the nodetype for the parse
  11397. tree and to the ComposableRecordReader to be created, including the
  11398. formals required to invoke the constructor.
  11399. The nodetype and constructor signature should be filled in from the
  11400. child node.]]>
  11401. </doc>
  11402. </method>
  11403. <method name="setID"
  11404. abstract="false" native="false" synchronized="false"
  11405. static="false" final="false" visibility="protected"
  11406. deprecated="not deprecated">
  11407. <param name="id" type="int"/>
  11408. </method>
  11409. <method name="setKeyComparator"
  11410. abstract="false" native="false" synchronized="false"
  11411. static="false" final="false" visibility="protected"
  11412. deprecated="not deprecated">
  11413. <param name="cmpcl" type="java.lang.Class"/>
  11414. </method>
  11415. <field name="rrCstrMap" type="java.util.Map"
  11416. transient="false" volatile="false"
  11417. static="true" final="true" visibility="protected"
  11418. deprecated="not deprecated">
  11419. </field>
  11420. <field name="id" type="int"
  11421. transient="false" volatile="false"
  11422. static="false" final="false" visibility="protected"
  11423. deprecated="not deprecated">
  11424. </field>
  11425. <field name="ident" type="java.lang.String"
  11426. transient="false" volatile="false"
  11427. static="false" final="false" visibility="protected"
  11428. deprecated="not deprecated">
  11429. </field>
  11430. <field name="cmpcl" type="java.lang.Class"
  11431. transient="false" volatile="false"
  11432. static="false" final="false" visibility="protected"
  11433. deprecated="not deprecated">
  11434. </field>
  11435. </class>
  11436. <!-- end class org.apache.hadoop.mapred.join.Parser.Node -->
  11437. <!-- start class org.apache.hadoop.mapred.join.Parser.NodeToken -->
  11438. <class name="Parser.NodeToken" extends="org.apache.hadoop.mapred.join.Parser.Token"
  11439. abstract="false"
  11440. static="true" final="false" visibility="public"
  11441. deprecated="not deprecated">
  11442. <method name="getNode" return="org.apache.hadoop.mapred.join.Parser.Node"
  11443. abstract="false" native="false" synchronized="false"
  11444. static="false" final="false" visibility="public"
  11445. deprecated="not deprecated">
  11446. </method>
  11447. </class>
  11448. <!-- end class org.apache.hadoop.mapred.join.Parser.NodeToken -->
  11449. <!-- start class org.apache.hadoop.mapred.join.Parser.NumToken -->
  11450. <class name="Parser.NumToken" extends="org.apache.hadoop.mapred.join.Parser.Token"
  11451. abstract="false"
  11452. static="true" final="false" visibility="public"
  11453. deprecated="not deprecated">
  11454. <constructor name="Parser.NumToken" type="double"
  11455. static="false" final="false" visibility="public"
  11456. deprecated="not deprecated">
  11457. </constructor>
  11458. <method name="getNum" return="double"
  11459. abstract="false" native="false" synchronized="false"
  11460. static="false" final="false" visibility="public"
  11461. deprecated="not deprecated">
  11462. </method>
  11463. </class>
  11464. <!-- end class org.apache.hadoop.mapred.join.Parser.NumToken -->
  11465. <!-- start class org.apache.hadoop.mapred.join.Parser.StrToken -->
  11466. <class name="Parser.StrToken" extends="org.apache.hadoop.mapred.join.Parser.Token"
  11467. abstract="false"
  11468. static="true" final="false" visibility="public"
  11469. deprecated="not deprecated">
  11470. <constructor name="Parser.StrToken" type="org.apache.hadoop.mapred.join.Parser.TType, java.lang.String"
  11471. static="false" final="false" visibility="public"
  11472. deprecated="not deprecated">
  11473. </constructor>
  11474. <method name="getStr" return="java.lang.String"
  11475. abstract="false" native="false" synchronized="false"
  11476. static="false" final="false" visibility="public"
  11477. deprecated="not deprecated">
  11478. </method>
  11479. </class>
  11480. <!-- end class org.apache.hadoop.mapred.join.Parser.StrToken -->
  11481. <!-- start class org.apache.hadoop.mapred.join.Parser.Token -->
  11482. <class name="Parser.Token" extends="java.lang.Object"
  11483. abstract="false"
  11484. static="true" final="false" visibility="public"
  11485. deprecated="not deprecated">
  11486. <method name="getType" return="org.apache.hadoop.mapred.join.Parser.TType"
  11487. abstract="false" native="false" synchronized="false"
  11488. static="false" final="false" visibility="public"
  11489. deprecated="not deprecated">
  11490. </method>
  11491. <method name="getNode" return="org.apache.hadoop.mapred.join.Parser.Node"
  11492. abstract="false" native="false" synchronized="false"
  11493. static="false" final="false" visibility="public"
  11494. deprecated="not deprecated">
  11495. <exception name="IOException" type="java.io.IOException"/>
  11496. </method>
  11497. <method name="getNum" return="double"
  11498. abstract="false" native="false" synchronized="false"
  11499. static="false" final="false" visibility="public"
  11500. deprecated="not deprecated">
  11501. <exception name="IOException" type="java.io.IOException"/>
  11502. </method>
  11503. <method name="getStr" return="java.lang.String"
  11504. abstract="false" native="false" synchronized="false"
  11505. static="false" final="false" visibility="public"
  11506. deprecated="not deprecated">
  11507. <exception name="IOException" type="java.io.IOException"/>
  11508. </method>
  11509. <doc>
  11510. <![CDATA[Tagged-union type for tokens from the join expression.
  11511. @see Parser.TType]]>
  11512. </doc>
  11513. </class>
  11514. <!-- end class org.apache.hadoop.mapred.join.Parser.Token -->
  11515. <!-- start class org.apache.hadoop.mapred.join.Parser.TType -->
  11516. <class name="Parser.TType" extends="java.lang.Enum"
  11517. abstract="false"
  11518. static="true" final="true" visibility="public"
  11519. deprecated="not deprecated">
  11520. <method name="values" return="org.apache.hadoop.mapred.join.Parser.TType[]"
  11521. abstract="false" native="false" synchronized="false"
  11522. static="true" final="false" visibility="public"
  11523. deprecated="not deprecated">
  11524. </method>
  11525. <method name="valueOf" return="org.apache.hadoop.mapred.join.Parser.TType"
  11526. abstract="false" native="false" synchronized="false"
  11527. static="true" final="false" visibility="public"
  11528. deprecated="not deprecated">
  11529. <param name="name" type="java.lang.String"/>
  11530. </method>
  11531. <field name="CIF" type="org.apache.hadoop.mapred.join.Parser.TType"
  11532. transient="false" volatile="false"
  11533. static="true" final="true" visibility="public"
  11534. deprecated="not deprecated">
  11535. </field>
  11536. <field name="IDENT" type="org.apache.hadoop.mapred.join.Parser.TType"
  11537. transient="false" volatile="false"
  11538. static="true" final="true" visibility="public"
  11539. deprecated="not deprecated">
  11540. </field>
  11541. <field name="COMMA" type="org.apache.hadoop.mapred.join.Parser.TType"
  11542. transient="false" volatile="false"
  11543. static="true" final="true" visibility="public"
  11544. deprecated="not deprecated">
  11545. </field>
  11546. <field name="LPAREN" type="org.apache.hadoop.mapred.join.Parser.TType"
  11547. transient="false" volatile="false"
  11548. static="true" final="true" visibility="public"
  11549. deprecated="not deprecated">
  11550. </field>
  11551. <field name="RPAREN" type="org.apache.hadoop.mapred.join.Parser.TType"
  11552. transient="false" volatile="false"
  11553. static="true" final="true" visibility="public"
  11554. deprecated="not deprecated">
  11555. </field>
  11556. <field name="QUOT" type="org.apache.hadoop.mapred.join.Parser.TType"
  11557. transient="false" volatile="false"
  11558. static="true" final="true" visibility="public"
  11559. deprecated="not deprecated">
  11560. </field>
  11561. <field name="NUM" type="org.apache.hadoop.mapred.join.Parser.TType"
  11562. transient="false" volatile="false"
  11563. static="true" final="true" visibility="public"
  11564. deprecated="not deprecated">
  11565. </field>
  11566. </class>
  11567. <!-- end class org.apache.hadoop.mapred.join.Parser.TType -->
  11568. <!-- start interface org.apache.hadoop.mapred.join.ResetableIterator -->
  11569. <interface name="ResetableIterator" abstract="true"
  11570. static="false" final="false" visibility="public"
  11571. deprecated="not deprecated">
  11572. <method name="hasNext" return="boolean"
  11573. abstract="false" native="false" synchronized="false"
  11574. static="false" final="false" visibility="public"
  11575. deprecated="not deprecated">
  11576. <doc>
  11577. <![CDATA[True if a call to next may return a value. This is permitted false
  11578. positives, but not false negatives.]]>
  11579. </doc>
  11580. </method>
  11581. <method name="next" return="boolean"
  11582. abstract="false" native="false" synchronized="false"
  11583. static="false" final="false" visibility="public"
  11584. deprecated="not deprecated">
  11585. <param name="val" type="org.apache.hadoop.io.Writable"/>
  11586. <exception name="IOException" type="java.io.IOException"/>
  11587. <doc>
  11588. <![CDATA[Assign next value to actual.
  11589. It is required that elements added to a ResetableIterator be returned in
  11590. the same order after a call to {@link #reset} (FIFO).
  11591. Note that a call to this may fail for nested joins (i.e. more elements
  11592. available, but none satisfying the constraints of the join)]]>
  11593. </doc>
  11594. </method>
  11595. <method name="replay" return="boolean"
  11596. abstract="false" native="false" synchronized="false"
  11597. static="false" final="false" visibility="public"
  11598. deprecated="not deprecated">
  11599. <param name="val" type="org.apache.hadoop.io.Writable"/>
  11600. <exception name="IOException" type="java.io.IOException"/>
  11601. <doc>
  11602. <![CDATA[Assign last value returned to actual.]]>
  11603. </doc>
  11604. </method>
  11605. <method name="reset"
  11606. abstract="false" native="false" synchronized="false"
  11607. static="false" final="false" visibility="public"
  11608. deprecated="not deprecated">
  11609. <doc>
  11610. <![CDATA[Set iterator to return to the start of its range. Must be called after
  11611. calling {@link #add} to avoid a ConcurrentModificationException.]]>
  11612. </doc>
  11613. </method>
  11614. <method name="add"
  11615. abstract="false" native="false" synchronized="false"
  11616. static="false" final="false" visibility="public"
  11617. deprecated="not deprecated">
  11618. <param name="item" type="org.apache.hadoop.io.Writable"/>
  11619. <exception name="IOException" type="java.io.IOException"/>
  11620. <doc>
  11621. <![CDATA[Add an element to the collection of elements to iterate over.]]>
  11622. </doc>
  11623. </method>
  11624. <method name="close"
  11625. abstract="false" native="false" synchronized="false"
  11626. static="false" final="false" visibility="public"
  11627. deprecated="not deprecated">
  11628. <exception name="IOException" type="java.io.IOException"/>
  11629. <doc>
  11630. <![CDATA[Close datasources and release resources. Calling methods on the iterator
  11631. after calling close has undefined behavior.]]>
  11632. </doc>
  11633. </method>
  11634. <method name="clear"
  11635. abstract="false" native="false" synchronized="false"
  11636. static="false" final="false" visibility="public"
  11637. deprecated="not deprecated">
  11638. <doc>
  11639. <![CDATA[Close datasources, but do not release internal resources. Calling this
  11640. method should permit the object to be reused with a different datasource.]]>
  11641. </doc>
  11642. </method>
  11643. <doc>
  11644. <![CDATA[This defines an interface to a stateful Iterator that can replay elements
  11645. added to it directly.
  11646. Note that this does not extend {@link java.util.Iterator}.]]>
  11647. </doc>
  11648. </interface>
  11649. <!-- end interface org.apache.hadoop.mapred.join.ResetableIterator -->
  11650. <!-- start class org.apache.hadoop.mapred.join.ResetableIterator.EMPTY -->
  11651. <class name="ResetableIterator.EMPTY" extends="java.lang.Object"
  11652. abstract="false"
  11653. static="true" final="false" visibility="public"
  11654. deprecated="not deprecated">
  11655. <implements name="org.apache.hadoop.mapred.join.ResetableIterator"/>
  11656. <constructor name="ResetableIterator.EMPTY"
  11657. static="false" final="false" visibility="public"
  11658. deprecated="not deprecated">
  11659. </constructor>
  11660. <method name="hasNext" return="boolean"
  11661. abstract="false" native="false" synchronized="false"
  11662. static="false" final="false" visibility="public"
  11663. deprecated="not deprecated">
  11664. </method>
  11665. <method name="reset"
  11666. abstract="false" native="false" synchronized="false"
  11667. static="false" final="false" visibility="public"
  11668. deprecated="not deprecated">
  11669. </method>
  11670. <method name="close"
  11671. abstract="false" native="false" synchronized="false"
  11672. static="false" final="false" visibility="public"
  11673. deprecated="not deprecated">
  11674. <exception name="IOException" type="java.io.IOException"/>
  11675. </method>
  11676. <method name="clear"
  11677. abstract="false" native="false" synchronized="false"
  11678. static="false" final="false" visibility="public"
  11679. deprecated="not deprecated">
  11680. </method>
  11681. <method name="next" return="boolean"
  11682. abstract="false" native="false" synchronized="false"
  11683. static="false" final="false" visibility="public"
  11684. deprecated="not deprecated">
  11685. <param name="val" type="org.apache.hadoop.io.Writable"/>
  11686. <exception name="IOException" type="java.io.IOException"/>
  11687. </method>
  11688. <method name="replay" return="boolean"
  11689. abstract="false" native="false" synchronized="false"
  11690. static="false" final="false" visibility="public"
  11691. deprecated="not deprecated">
  11692. <param name="val" type="org.apache.hadoop.io.Writable"/>
  11693. <exception name="IOException" type="java.io.IOException"/>
  11694. </method>
  11695. <method name="add"
  11696. abstract="false" native="false" synchronized="false"
  11697. static="false" final="false" visibility="public"
  11698. deprecated="not deprecated">
  11699. <param name="item" type="org.apache.hadoop.io.Writable"/>
  11700. <exception name="IOException" type="java.io.IOException"/>
  11701. </method>
  11702. </class>
  11703. <!-- end class org.apache.hadoop.mapred.join.ResetableIterator.EMPTY -->
  11704. <!-- start class org.apache.hadoop.mapred.join.StreamBackedIterator -->
  11705. <class name="StreamBackedIterator" extends="java.lang.Object"
  11706. abstract="false"
  11707. static="false" final="false" visibility="public"
  11708. deprecated="not deprecated">
  11709. <implements name="org.apache.hadoop.mapred.join.ResetableIterator"/>
  11710. <constructor name="StreamBackedIterator"
  11711. static="false" final="false" visibility="public"
  11712. deprecated="not deprecated">
  11713. </constructor>
  11714. <method name="hasNext" return="boolean"
  11715. abstract="false" native="false" synchronized="false"
  11716. static="false" final="false" visibility="public"
  11717. deprecated="not deprecated">
  11718. </method>
  11719. <method name="next" return="boolean"
  11720. abstract="false" native="false" synchronized="false"
  11721. static="false" final="false" visibility="public"
  11722. deprecated="not deprecated">
  11723. <param name="val" type="org.apache.hadoop.io.Writable"/>
  11724. <exception name="IOException" type="java.io.IOException"/>
  11725. </method>
  11726. <method name="replay" return="boolean"
  11727. abstract="false" native="false" synchronized="false"
  11728. static="false" final="false" visibility="public"
  11729. deprecated="not deprecated">
  11730. <param name="val" type="org.apache.hadoop.io.Writable"/>
  11731. <exception name="IOException" type="java.io.IOException"/>
  11732. </method>
  11733. <method name="reset"
  11734. abstract="false" native="false" synchronized="false"
  11735. static="false" final="false" visibility="public"
  11736. deprecated="not deprecated">
  11737. </method>
  11738. <method name="add"
  11739. abstract="false" native="false" synchronized="false"
  11740. static="false" final="false" visibility="public"
  11741. deprecated="not deprecated">
  11742. <param name="item" type="org.apache.hadoop.io.Writable"/>
  11743. <exception name="IOException" type="java.io.IOException"/>
  11744. </method>
  11745. <method name="close"
  11746. abstract="false" native="false" synchronized="false"
  11747. static="false" final="false" visibility="public"
  11748. deprecated="not deprecated">
  11749. <exception name="IOException" type="java.io.IOException"/>
  11750. </method>
  11751. <method name="clear"
  11752. abstract="false" native="false" synchronized="false"
  11753. static="false" final="false" visibility="public"
  11754. deprecated="not deprecated">
  11755. </method>
  11756. <doc>
  11757. <![CDATA[This class provides an implementation of ResetableIterator. This
  11758. implementation uses a byte array to store elements added to it.]]>
  11759. </doc>
  11760. </class>
  11761. <!-- end class org.apache.hadoop.mapred.join.StreamBackedIterator -->
  11762. <!-- start class org.apache.hadoop.mapred.join.TupleWritable -->
  11763. <class name="TupleWritable" extends="java.lang.Object"
  11764. abstract="false"
  11765. static="false" final="false" visibility="public"
  11766. deprecated="not deprecated">
  11767. <implements name="org.apache.hadoop.io.Writable"/>
  11768. <implements name="java.lang.Iterable"/>
  11769. <constructor name="TupleWritable"
  11770. static="false" final="false" visibility="public"
  11771. deprecated="not deprecated">
  11772. <doc>
  11773. <![CDATA[Create an empty tuple with no allocated storage for writables.]]>
  11774. </doc>
  11775. </constructor>
  11776. <constructor name="TupleWritable" type="org.apache.hadoop.io.Writable[]"
  11777. static="false" final="false" visibility="public"
  11778. deprecated="not deprecated">
  11779. <doc>
  11780. <![CDATA[Initialize tuple with storage; unknown whether any of them contain
  11781. &quot;written&quot; values.]]>
  11782. </doc>
  11783. </constructor>
  11784. <method name="has" return="boolean"
  11785. abstract="false" native="false" synchronized="false"
  11786. static="false" final="false" visibility="public"
  11787. deprecated="not deprecated">
  11788. <param name="i" type="int"/>
  11789. <doc>
  11790. <![CDATA[Return true if tuple has an element at the position provided.]]>
  11791. </doc>
  11792. </method>
  11793. <method name="get" return="org.apache.hadoop.io.Writable"
  11794. abstract="false" native="false" synchronized="false"
  11795. static="false" final="false" visibility="public"
  11796. deprecated="not deprecated">
  11797. <param name="i" type="int"/>
  11798. <doc>
  11799. <![CDATA[Get ith Writable from Tuple.]]>
  11800. </doc>
  11801. </method>
  11802. <method name="size" return="int"
  11803. abstract="false" native="false" synchronized="false"
  11804. static="false" final="false" visibility="public"
  11805. deprecated="not deprecated">
  11806. <doc>
  11807. <![CDATA[The number of children in this Tuple.]]>
  11808. </doc>
  11809. </method>
  11810. <method name="equals" return="boolean"
  11811. abstract="false" native="false" synchronized="false"
  11812. static="false" final="false" visibility="public"
  11813. deprecated="not deprecated">
  11814. <param name="other" type="java.lang.Object"/>
  11815. <doc>
  11816. <![CDATA[{@inheritDoc}]]>
  11817. </doc>
  11818. </method>
  11819. <method name="hashCode" return="int"
  11820. abstract="false" native="false" synchronized="false"
  11821. static="false" final="false" visibility="public"
  11822. deprecated="not deprecated">
  11823. </method>
  11824. <method name="iterator" return="java.util.Iterator"
  11825. abstract="false" native="false" synchronized="false"
  11826. static="false" final="false" visibility="public"
  11827. deprecated="not deprecated">
  11828. <doc>
  11829. <![CDATA[Return an iterator over the elements in this tuple.
  11830. Note that this doesn't flatten the tuple; one may receive tuples
  11831. from this iterator.]]>
  11832. </doc>
  11833. </method>
  11834. <method name="toString" return="java.lang.String"
  11835. abstract="false" native="false" synchronized="false"
  11836. static="false" final="false" visibility="public"
  11837. deprecated="not deprecated">
  11838. <doc>
  11839. <![CDATA[Convert Tuple to String as in the following.
  11840. <tt>[<child1>,<child2>,...,<childn>]</tt>]]>
  11841. </doc>
  11842. </method>
  11843. <method name="write"
  11844. abstract="false" native="false" synchronized="false"
  11845. static="false" final="false" visibility="public"
  11846. deprecated="not deprecated">
  11847. <param name="out" type="java.io.DataOutput"/>
  11848. <exception name="IOException" type="java.io.IOException"/>
  11849. <doc>
  11850. <![CDATA[Writes each Writable to <code>out</code>.
  11851. TupleWritable format:
  11852. {@code
  11853. <count><type1><type2>...<typen><obj1><obj2>...<objn>
  11854. }]]>
  11855. </doc>
  11856. </method>
  11857. <method name="readFields"
  11858. abstract="false" native="false" synchronized="false"
  11859. static="false" final="false" visibility="public"
  11860. deprecated="not deprecated">
  11861. <param name="in" type="java.io.DataInput"/>
  11862. <exception name="IOException" type="java.io.IOException"/>
  11863. <doc>
  11864. <![CDATA[{@inheritDoc}]]>
  11865. </doc>
  11866. </method>
  11867. <doc>
  11868. <![CDATA[Writable type storing multiple {@link org.apache.hadoop.io.Writable}s.
  11869. This is *not* a general-purpose tuple type. In almost all cases, users are
  11870. encouraged to implement their own serializable types, which can perform
  11871. better validation and provide more efficient encodings than this class is
  11872. capable. TupleWritable relies on the join framework for type safety and
  11873. assumes its instances will rarely be persisted, assumptions not only
  11874. incompatible with, but contrary to the general case.
  11875. @see org.apache.hadoop.io.Writable]]>
  11876. </doc>
  11877. </class>
  11878. <!-- end class org.apache.hadoop.mapred.join.TupleWritable -->
  11879. <!-- start class org.apache.hadoop.mapred.join.WrappedRecordReader -->
  11880. <class name="WrappedRecordReader" extends="java.lang.Object"
  11881. abstract="false"
  11882. static="false" final="false" visibility="public"
  11883. deprecated="not deprecated">
  11884. <implements name="org.apache.hadoop.mapred.join.ComposableRecordReader"/>
  11885. <method name="id" return="int"
  11886. abstract="false" native="false" synchronized="false"
  11887. static="false" final="false" visibility="public"
  11888. deprecated="not deprecated">
  11889. <doc>
  11890. <![CDATA[{@inheritDoc}]]>
  11891. </doc>
  11892. </method>
  11893. <method name="key" return="org.apache.hadoop.io.WritableComparable"
  11894. abstract="false" native="false" synchronized="false"
  11895. static="false" final="false" visibility="public"
  11896. deprecated="not deprecated">
  11897. <doc>
  11898. <![CDATA[Return the key at the head of this RR.]]>
  11899. </doc>
  11900. </method>
  11901. <method name="key"
  11902. abstract="false" native="false" synchronized="false"
  11903. static="false" final="false" visibility="public"
  11904. deprecated="not deprecated">
  11905. <param name="qkey" type="org.apache.hadoop.io.WritableComparable"/>
  11906. <exception name="IOException" type="java.io.IOException"/>
  11907. <doc>
  11908. <![CDATA[Clone the key at the head of this RR into the object supplied.]]>
  11909. </doc>
  11910. </method>
  11911. <method name="hasNext" return="boolean"
  11912. abstract="false" native="false" synchronized="false"
  11913. static="false" final="false" visibility="public"
  11914. deprecated="not deprecated">
  11915. <doc>
  11916. <![CDATA[Return true if the RR- including the k,v pair stored in this object-
  11917. is exhausted.]]>
  11918. </doc>
  11919. </method>
  11920. <method name="skip"
  11921. abstract="false" native="false" synchronized="false"
  11922. static="false" final="false" visibility="public"
  11923. deprecated="not deprecated">
  11924. <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
  11925. <exception name="IOException" type="java.io.IOException"/>
  11926. <doc>
  11927. <![CDATA[Skip key-value pairs with keys less than or equal to the key provided.]]>
  11928. </doc>
  11929. </method>
  11930. <method name="next" return="boolean"
  11931. abstract="false" native="false" synchronized="false"
  11932. static="false" final="false" visibility="protected"
  11933. deprecated="not deprecated">
  11934. <exception name="IOException" type="java.io.IOException"/>
  11935. <doc>
  11936. <![CDATA[Read the next k,v pair into the head of this object; return true iff
  11937. the RR and this are exhausted.]]>
  11938. </doc>
  11939. </method>
  11940. <method name="accept"
  11941. abstract="false" native="false" synchronized="false"
  11942. static="false" final="false" visibility="public"
  11943. deprecated="not deprecated">
  11944. <param name="i" type="org.apache.hadoop.mapred.join.CompositeRecordReader.JoinCollector"/>
  11945. <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
  11946. <exception name="IOException" type="java.io.IOException"/>
  11947. <doc>
  11948. <![CDATA[Add an iterator to the collector at the position occupied by this
  11949. RecordReader over the values in this stream paired with the key
  11950. provided (ie register a stream of values from this source matching K
  11951. with a collector).]]>
  11952. </doc>
  11953. </method>
  11954. <method name="next" return="boolean"
  11955. abstract="false" native="false" synchronized="false"
  11956. static="false" final="false" visibility="public"
  11957. deprecated="not deprecated">
  11958. <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
  11959. <param name="value" type="org.apache.hadoop.io.Writable"/>
  11960. <exception name="IOException" type="java.io.IOException"/>
  11961. <doc>
  11962. <![CDATA[Write key-value pair at the head of this stream to the objects provided;
  11963. get next key-value pair from proxied RR.]]>
  11964. </doc>
  11965. </method>
  11966. <method name="createKey" return="org.apache.hadoop.io.WritableComparable"
  11967. abstract="false" native="false" synchronized="false"
  11968. static="false" final="false" visibility="public"
  11969. deprecated="not deprecated">
  11970. <doc>
  11971. <![CDATA[Request new key from proxied RR.]]>
  11972. </doc>
  11973. </method>
  11974. <method name="createValue" return="org.apache.hadoop.io.Writable"
  11975. abstract="false" native="false" synchronized="false"
  11976. static="false" final="false" visibility="public"
  11977. deprecated="not deprecated">
  11978. <doc>
  11979. <![CDATA[Request new value from proxied RR.]]>
  11980. </doc>
  11981. </method>
  11982. <method name="getProgress" return="float"
  11983. abstract="false" native="false" synchronized="false"
  11984. static="false" final="false" visibility="public"
  11985. deprecated="not deprecated">
  11986. <exception name="IOException" type="java.io.IOException"/>
  11987. <doc>
  11988. <![CDATA[Request progress from proxied RR.]]>
  11989. </doc>
  11990. </method>
  11991. <method name="getPos" return="long"
  11992. abstract="false" native="false" synchronized="false"
  11993. static="false" final="false" visibility="public"
  11994. deprecated="not deprecated">
  11995. <exception name="IOException" type="java.io.IOException"/>
  11996. <doc>
  11997. <![CDATA[Request position from proxied RR.]]>
  11998. </doc>
  11999. </method>
  12000. <method name="close"
  12001. abstract="false" native="false" synchronized="false"
  12002. static="false" final="false" visibility="public"
  12003. deprecated="not deprecated">
  12004. <exception name="IOException" type="java.io.IOException"/>
  12005. <doc>
  12006. <![CDATA[Forward close request to proxied RR.]]>
  12007. </doc>
  12008. </method>
  12009. <method name="compareTo" return="int"
  12010. abstract="false" native="false" synchronized="false"
  12011. static="false" final="false" visibility="public"
  12012. deprecated="not deprecated">
  12013. <param name="other" type="org.apache.hadoop.mapred.join.ComposableRecordReader"/>
  12014. <doc>
  12015. <![CDATA[Implement Comparable contract (compare key at head of proxied RR
  12016. with that of another).]]>
  12017. </doc>
  12018. </method>
  12019. <method name="equals" return="boolean"
  12020. abstract="false" native="false" synchronized="false"
  12021. static="false" final="false" visibility="public"
  12022. deprecated="not deprecated">
  12023. <param name="other" type="java.lang.Object"/>
  12024. <doc>
  12025. <![CDATA[Return true iff compareTo(other) retn true.]]>
  12026. </doc>
  12027. </method>
  12028. <method name="hashCode" return="int"
  12029. abstract="false" native="false" synchronized="false"
  12030. static="false" final="false" visibility="public"
  12031. deprecated="not deprecated">
  12032. </method>
  12033. <doc>
  12034. <![CDATA[Proxy class for a RecordReader participating in the join framework.
  12035. This class keeps track of the &quot;head&quot; key-value pair for the
  12036. provided RecordReader and keeps a store of values matching a key when
  12037. this source is participating in a join.]]>
  12038. </doc>
  12039. </class>
  12040. <!-- end class org.apache.hadoop.mapred.join.WrappedRecordReader -->
  12041. </package>
  12042. <package name="org.apache.hadoop.mapred.lib">
  12043. <!-- start class org.apache.hadoop.mapred.lib.ChainMapper -->
  12044. <class name="ChainMapper" extends="java.lang.Object"
  12045. abstract="false"
  12046. static="false" final="false" visibility="public"
  12047. deprecated="not deprecated">
  12048. <implements name="org.apache.hadoop.mapred.Mapper"/>
  12049. <constructor name="ChainMapper"
  12050. static="false" final="false" visibility="public"
  12051. deprecated="not deprecated">
  12052. <doc>
  12053. <![CDATA[Constructor.]]>
  12054. </doc>
  12055. </constructor>
  12056. <method name="addMapper"
  12057. abstract="false" native="false" synchronized="false"
  12058. static="true" final="false" visibility="public"
  12059. deprecated="not deprecated">
  12060. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  12061. <param name="klass" type="java.lang.Class"/>
  12062. <param name="inputKeyClass" type="java.lang.Class"/>
  12063. <param name="inputValueClass" type="java.lang.Class"/>
  12064. <param name="outputKeyClass" type="java.lang.Class"/>
  12065. <param name="outputValueClass" type="java.lang.Class"/>
  12066. <param name="byValue" type="boolean"/>
  12067. <param name="mapperConf" type="org.apache.hadoop.mapred.JobConf"/>
  12068. <doc>
  12069. <![CDATA[Adds a Mapper class to the chain job's JobConf.
  12070. <p/>
  12071. It has to be specified how key and values are passed from one element of
  12072. the chain to the next, by value or by reference. If a Mapper leverages the
  12073. assumed semantics that the key and values are not modified by the collector
  12074. 'by value' must be used. If the Mapper does not expect this semantics, as
  12075. an optimization to avoid serialization and deserialization 'by reference'
  12076. can be used.
  12077. <p/>
  12078. For the added Mapper the configuration given for it,
  12079. <code>mapperConf</code>, have precedence over the job's JobConf. This
  12080. precedence is in effect when the task is running.
  12081. <p/>
  12082. IMPORTANT: There is no need to specify the output key/value classes for the
  12083. ChainMapper, this is done by the addMapper for the last mapper in the chain
  12084. <p/>
  12085. @param job job's JobConf to add the Mapper class.
  12086. @param klass the Mapper class to add.
  12087. @param inputKeyClass mapper input key class.
  12088. @param inputValueClass mapper input value class.
  12089. @param outputKeyClass mapper output key class.
  12090. @param outputValueClass mapper output value class.
  12091. @param byValue indicates if key/values should be passed by value
  12092. to the next Mapper in the chain, if any.
  12093. @param mapperConf a JobConf with the configuration for the Mapper
  12094. class. It is recommended to use a JobConf without default values using the
  12095. <code>JobConf(boolean loadDefaults)</code> constructor with FALSE.]]>
  12096. </doc>
  12097. </method>
  12098. <method name="configure"
  12099. abstract="false" native="false" synchronized="false"
  12100. static="false" final="false" visibility="public"
  12101. deprecated="not deprecated">
  12102. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  12103. <doc>
  12104. <![CDATA[Configures the ChainMapper and all the Mappers in the chain.
  12105. <p/>
  12106. If this method is overriden <code>super.configure(...)</code> should be
  12107. invoked at the beginning of the overwriter method.]]>
  12108. </doc>
  12109. </method>
  12110. <method name="map"
  12111. abstract="false" native="false" synchronized="false"
  12112. static="false" final="false" visibility="public"
  12113. deprecated="not deprecated">
  12114. <param name="key" type="java.lang.Object"/>
  12115. <param name="value" type="java.lang.Object"/>
  12116. <param name="output" type="org.apache.hadoop.mapred.OutputCollector"/>
  12117. <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
  12118. <exception name="IOException" type="java.io.IOException"/>
  12119. <doc>
  12120. <![CDATA[Chains the <code>map(...)</code> methods of the Mappers in the chain.]]>
  12121. </doc>
  12122. </method>
  12123. <method name="close"
  12124. abstract="false" native="false" synchronized="false"
  12125. static="false" final="false" visibility="public"
  12126. deprecated="not deprecated">
  12127. <exception name="IOException" type="java.io.IOException"/>
  12128. <doc>
  12129. <![CDATA[Closes the ChainMapper and all the Mappers in the chain.
  12130. <p/>
  12131. If this method is overriden <code>super.close()</code> should be
  12132. invoked at the end of the overwriter method.]]>
  12133. </doc>
  12134. </method>
  12135. <doc>
  12136. <![CDATA[The ChainMapper class allows to use multiple Mapper classes within a single
  12137. Map task.
  12138. <p/>
  12139. The Mapper classes are invoked in a chained (or piped) fashion, the output of
  12140. the first becomes the input of the second, and so on until the last Mapper,
  12141. the output of the last Mapper will be written to the task's output.
  12142. <p/>
  12143. The key functionality of this feature is that the Mappers in the chain do not
  12144. need to be aware that they are executed in a chain. This enables having
  12145. reusable specialized Mappers that can be combined to perform composite
  12146. operations within a single task.
  12147. <p/>
  12148. Special care has to be taken when creating chains that the key/values output
  12149. by a Mapper are valid for the following Mapper in the chain. It is assumed
  12150. all Mappers and the Reduce in the chain use maching output and input key and
  12151. value classes as no conversion is done by the chaining code.
  12152. <p/>
  12153. Using the ChainMapper and the ChainReducer classes is possible to compose
  12154. Map/Reduce jobs that look like <code>[MAP+ / REDUCE MAP*]</code>. And
  12155. immediate benefit of this pattern is a dramatic reduction in disk IO.
  12156. <p/>
  12157. IMPORTANT: There is no need to specify the output key/value classes for the
  12158. ChainMapper, this is done by the addMapper for the last mapper in the chain.
  12159. <p/>
  12160. ChainMapper usage pattern:
  12161. <p/>
  12162. <pre>
  12163. ...
  12164. conf.setJobName("chain");
  12165. conf.setInputFormat(TextInputFormat.class);
  12166. conf.setOutputFormat(TextOutputFormat.class);
  12167. <p/>
  12168. JobConf mapAConf = new JobConf(false);
  12169. ...
  12170. ChainMapper.addMapper(conf, AMap.class, LongWritable.class, Text.class,
  12171. Text.class, Text.class, true, mapAConf);
  12172. <p/>
  12173. JobConf mapBConf = new JobConf(false);
  12174. ...
  12175. ChainMapper.addMapper(conf, BMap.class, Text.class, Text.class,
  12176. LongWritable.class, Text.class, false, mapBConf);
  12177. <p/>
  12178. JobConf reduceConf = new JobConf(false);
  12179. ...
  12180. ChainReducer.setReducer(conf, XReduce.class, LongWritable.class, Text.class,
  12181. Text.class, Text.class, true, reduceConf);
  12182. <p/>
  12183. ChainReducer.addMapper(conf, CMap.class, Text.class, Text.class,
  12184. LongWritable.class, Text.class, false, null);
  12185. <p/>
  12186. ChainReducer.addMapper(conf, DMap.class, LongWritable.class, Text.class,
  12187. LongWritable.class, LongWritable.class, true, null);
  12188. <p/>
  12189. FileInputFormat.setInputPaths(conf, inDir);
  12190. FileOutputFormat.setOutputPath(conf, outDir);
  12191. ...
  12192. <p/>
  12193. JobClient jc = new JobClient(conf);
  12194. RunningJob job = jc.submitJob(conf);
  12195. ...
  12196. </pre>]]>
  12197. </doc>
  12198. </class>
  12199. <!-- end class org.apache.hadoop.mapred.lib.ChainMapper -->
  12200. <!-- start class org.apache.hadoop.mapred.lib.ChainReducer -->
  12201. <class name="ChainReducer" extends="java.lang.Object"
  12202. abstract="false"
  12203. static="false" final="false" visibility="public"
  12204. deprecated="not deprecated">
  12205. <implements name="org.apache.hadoop.mapred.Reducer"/>
  12206. <constructor name="ChainReducer"
  12207. static="false" final="false" visibility="public"
  12208. deprecated="not deprecated">
  12209. <doc>
  12210. <![CDATA[Constructor.]]>
  12211. </doc>
  12212. </constructor>
  12213. <method name="setReducer"
  12214. abstract="false" native="false" synchronized="false"
  12215. static="true" final="false" visibility="public"
  12216. deprecated="not deprecated">
  12217. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  12218. <param name="klass" type="java.lang.Class"/>
  12219. <param name="inputKeyClass" type="java.lang.Class"/>
  12220. <param name="inputValueClass" type="java.lang.Class"/>
  12221. <param name="outputKeyClass" type="java.lang.Class"/>
  12222. <param name="outputValueClass" type="java.lang.Class"/>
  12223. <param name="byValue" type="boolean"/>
  12224. <param name="reducerConf" type="org.apache.hadoop.mapred.JobConf"/>
  12225. <doc>
  12226. <![CDATA[Sets the Reducer class to the chain job's JobConf.
  12227. <p/>
  12228. It has to be specified how key and values are passed from one element of
  12229. the chain to the next, by value or by reference. If a Reducer leverages the
  12230. assumed semantics that the key and values are not modified by the collector
  12231. 'by value' must be used. If the Reducer does not expect this semantics, as
  12232. an optimization to avoid serialization and deserialization 'by reference'
  12233. can be used.
  12234. <p/>
  12235. For the added Reducer the configuration given for it,
  12236. <code>reducerConf</code>, have precedence over the job's JobConf. This
  12237. precedence is in effect when the task is running.
  12238. <p/>
  12239. IMPORTANT: There is no need to specify the output key/value classes for the
  12240. ChainReducer, this is done by the setReducer or the addMapper for the last
  12241. element in the chain.
  12242. @param job job's JobConf to add the Reducer class.
  12243. @param klass the Reducer class to add.
  12244. @param inputKeyClass reducer input key class.
  12245. @param inputValueClass reducer input value class.
  12246. @param outputKeyClass reducer output key class.
  12247. @param outputValueClass reducer output value class.
  12248. @param byValue indicates if key/values should be passed by value
  12249. to the next Mapper in the chain, if any.
  12250. @param reducerConf a JobConf with the configuration for the Reducer
  12251. class. It is recommended to use a JobConf without default values using the
  12252. <code>JobConf(boolean loadDefaults)</code> constructor with FALSE.]]>
  12253. </doc>
  12254. </method>
  12255. <method name="addMapper"
  12256. abstract="false" native="false" synchronized="false"
  12257. static="true" final="false" visibility="public"
  12258. deprecated="not deprecated">
  12259. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  12260. <param name="klass" type="java.lang.Class"/>
  12261. <param name="inputKeyClass" type="java.lang.Class"/>
  12262. <param name="inputValueClass" type="java.lang.Class"/>
  12263. <param name="outputKeyClass" type="java.lang.Class"/>
  12264. <param name="outputValueClass" type="java.lang.Class"/>
  12265. <param name="byValue" type="boolean"/>
  12266. <param name="mapperConf" type="org.apache.hadoop.mapred.JobConf"/>
  12267. <doc>
  12268. <![CDATA[Adds a Mapper class to the chain job's JobConf.
  12269. <p/>
  12270. It has to be specified how key and values are passed from one element of
  12271. the chain to the next, by value or by reference. If a Mapper leverages the
  12272. assumed semantics that the key and values are not modified by the collector
  12273. 'by value' must be used. If the Mapper does not expect this semantics, as
  12274. an optimization to avoid serialization and deserialization 'by reference'
  12275. can be used.
  12276. <p/>
  12277. For the added Mapper the configuration given for it,
  12278. <code>mapperConf</code>, have precedence over the job's JobConf. This
  12279. precedence is in effect when the task is running.
  12280. <p/>
  12281. IMPORTANT: There is no need to specify the output key/value classes for the
  12282. ChainMapper, this is done by the addMapper for the last mapper in the chain
  12283. .
  12284. @param job chain job's JobConf to add the Mapper class.
  12285. @param klass the Mapper class to add.
  12286. @param inputKeyClass mapper input key class.
  12287. @param inputValueClass mapper input value class.
  12288. @param outputKeyClass mapper output key class.
  12289. @param outputValueClass mapper output value class.
  12290. @param byValue indicates if key/values should be passed by value
  12291. to the next Mapper in the chain, if any.
  12292. @param mapperConf a JobConf with the configuration for the Mapper
  12293. class. It is recommended to use a JobConf without default values using the
  12294. <code>JobConf(boolean loadDefaults)</code> constructor with FALSE.]]>
  12295. </doc>
  12296. </method>
  12297. <method name="configure"
  12298. abstract="false" native="false" synchronized="false"
  12299. static="false" final="false" visibility="public"
  12300. deprecated="not deprecated">
  12301. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  12302. <doc>
  12303. <![CDATA[Configures the ChainReducer, the Reducer and all the Mappers in the chain.
  12304. <p/>
  12305. If this method is overriden <code>super.configure(...)</code> should be
  12306. invoked at the beginning of the overwriter method.]]>
  12307. </doc>
  12308. </method>
  12309. <method name="reduce"
  12310. abstract="false" native="false" synchronized="false"
  12311. static="false" final="false" visibility="public"
  12312. deprecated="not deprecated">
  12313. <param name="key" type="java.lang.Object"/>
  12314. <param name="values" type="java.util.Iterator"/>
  12315. <param name="output" type="org.apache.hadoop.mapred.OutputCollector"/>
  12316. <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
  12317. <exception name="IOException" type="java.io.IOException"/>
  12318. <doc>
  12319. <![CDATA[Chains the <code>reduce(...)</code> method of the Reducer with the
  12320. <code>map(...) </code> methods of the Mappers in the chain.]]>
  12321. </doc>
  12322. </method>
  12323. <method name="close"
  12324. abstract="false" native="false" synchronized="false"
  12325. static="false" final="false" visibility="public"
  12326. deprecated="not deprecated">
  12327. <exception name="IOException" type="java.io.IOException"/>
  12328. <doc>
  12329. <![CDATA[Closes the ChainReducer, the Reducer and all the Mappers in the chain.
  12330. <p/>
  12331. If this method is overriden <code>super.close()</code> should be
  12332. invoked at the end of the overwriter method.]]>
  12333. </doc>
  12334. </method>
  12335. <doc>
  12336. <![CDATA[The ChainReducer class allows to chain multiple Mapper classes after a
  12337. Reducer within the Reducer task.
  12338. <p/>
  12339. For each record output by the Reducer, the Mapper classes are invoked in a
  12340. chained (or piped) fashion, the output of the first becomes the input of the
  12341. second, and so on until the last Mapper, the output of the last Mapper will
  12342. be written to the task's output.
  12343. <p/>
  12344. The key functionality of this feature is that the Mappers in the chain do not
  12345. need to be aware that they are executed after the Reducer or in a chain.
  12346. This enables having reusable specialized Mappers that can be combined to
  12347. perform composite operations within a single task.
  12348. <p/>
  12349. Special care has to be taken when creating chains that the key/values output
  12350. by a Mapper are valid for the following Mapper in the chain. It is assumed
  12351. all Mappers and the Reduce in the chain use maching output and input key and
  12352. value classes as no conversion is done by the chaining code.
  12353. <p/>
  12354. Using the ChainMapper and the ChainReducer classes is possible to compose
  12355. Map/Reduce jobs that look like <code>[MAP+ / REDUCE MAP*]</code>. And
  12356. immediate benefit of this pattern is a dramatic reduction in disk IO.
  12357. <p/>
  12358. IMPORTANT: There is no need to specify the output key/value classes for the
  12359. ChainReducer, this is done by the setReducer or the addMapper for the last
  12360. element in the chain.
  12361. <p/>
  12362. ChainReducer usage pattern:
  12363. <p/>
  12364. <pre>
  12365. ...
  12366. conf.setJobName("chain");
  12367. conf.setInputFormat(TextInputFormat.class);
  12368. conf.setOutputFormat(TextOutputFormat.class);
  12369. <p/>
  12370. JobConf mapAConf = new JobConf(false);
  12371. ...
  12372. ChainMapper.addMapper(conf, AMap.class, LongWritable.class, Text.class,
  12373. Text.class, Text.class, true, mapAConf);
  12374. <p/>
  12375. JobConf mapBConf = new JobConf(false);
  12376. ...
  12377. ChainMapper.addMapper(conf, BMap.class, Text.class, Text.class,
  12378. LongWritable.class, Text.class, false, mapBConf);
  12379. <p/>
  12380. JobConf reduceConf = new JobConf(false);
  12381. ...
  12382. ChainReducer.setReducer(conf, XReduce.class, LongWritable.class, Text.class,
  12383. Text.class, Text.class, true, reduceConf);
  12384. <p/>
  12385. ChainReducer.addMapper(conf, CMap.class, Text.class, Text.class,
  12386. LongWritable.class, Text.class, false, null);
  12387. <p/>
  12388. ChainReducer.addMapper(conf, DMap.class, LongWritable.class, Text.class,
  12389. LongWritable.class, LongWritable.class, true, null);
  12390. <p/>
  12391. FileInputFormat.setInputPaths(conf, inDir);
  12392. FileOutputFormat.setOutputPath(conf, outDir);
  12393. ...
  12394. <p/>
  12395. JobClient jc = new JobClient(conf);
  12396. RunningJob job = jc.submitJob(conf);
  12397. ...
  12398. </pre>]]>
  12399. </doc>
  12400. </class>
  12401. <!-- end class org.apache.hadoop.mapred.lib.ChainReducer -->
  12402. <!-- start class org.apache.hadoop.mapred.lib.CombineFileInputFormat -->
  12403. <class name="CombineFileInputFormat" extends="org.apache.hadoop.mapred.FileInputFormat"
  12404. abstract="true"
  12405. static="false" final="false" visibility="public"
  12406. deprecated="not deprecated">
  12407. <constructor name="CombineFileInputFormat"
  12408. static="false" final="false" visibility="public"
  12409. deprecated="not deprecated">
  12410. <doc>
  12411. <![CDATA[default constructor]]>
  12412. </doc>
  12413. </constructor>
  12414. <method name="setMaxSplitSize"
  12415. abstract="false" native="false" synchronized="false"
  12416. static="false" final="false" visibility="protected"
  12417. deprecated="not deprecated">
  12418. <param name="maxSplitSize" type="long"/>
  12419. <doc>
  12420. <![CDATA[Specify the maximum size (in bytes) of each split. Each split is
  12421. approximately equal to the specified size.]]>
  12422. </doc>
  12423. </method>
  12424. <method name="setMinSplitSizeNode"
  12425. abstract="false" native="false" synchronized="false"
  12426. static="false" final="false" visibility="protected"
  12427. deprecated="not deprecated">
  12428. <param name="minSplitSizeNode" type="long"/>
  12429. <doc>
  12430. <![CDATA[Specify the minimum size (in bytes) of each split per node.
  12431. This applies to data that is left over after combining data on a single
  12432. node into splits that are of maximum size specified by maxSplitSize.
  12433. This leftover data will be combined into its own split if its size
  12434. exceeds minSplitSizeNode.]]>
  12435. </doc>
  12436. </method>
  12437. <method name="setMinSplitSizeRack"
  12438. abstract="false" native="false" synchronized="false"
  12439. static="false" final="false" visibility="protected"
  12440. deprecated="not deprecated">
  12441. <param name="minSplitSizeRack" type="long"/>
  12442. <doc>
  12443. <![CDATA[Specify the minimum size (in bytes) of each split per rack.
  12444. This applies to data that is left over after combining data on a single
  12445. rack into splits that are of maximum size specified by maxSplitSize.
  12446. This leftover data will be combined into its own split if its size
  12447. exceeds minSplitSizeRack.]]>
  12448. </doc>
  12449. </method>
  12450. <method name="createPool"
  12451. abstract="false" native="false" synchronized="false"
  12452. static="false" final="false" visibility="protected"
  12453. deprecated="not deprecated">
  12454. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  12455. <param name="filters" type="java.util.List"/>
  12456. <doc>
  12457. <![CDATA[Create a new pool and add the filters to it.
  12458. A split cannot have files from different pools.]]>
  12459. </doc>
  12460. </method>
  12461. <method name="createPool"
  12462. abstract="false" native="false" synchronized="false"
  12463. static="false" final="false" visibility="protected"
  12464. deprecated="not deprecated">
  12465. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  12466. <param name="filters" type="org.apache.hadoop.fs.PathFilter[]"/>
  12467. <doc>
  12468. <![CDATA[Create a new pool and add the filters to it.
  12469. A pathname can satisfy any one of the specified filters.
  12470. A split cannot have files from different pools.]]>
  12471. </doc>
  12472. </method>
  12473. <method name="getSplits" return="org.apache.hadoop.mapred.InputSplit[]"
  12474. abstract="false" native="false" synchronized="false"
  12475. static="false" final="false" visibility="public"
  12476. deprecated="not deprecated">
  12477. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  12478. <param name="numSplits" type="int"/>
  12479. <exception name="IOException" type="java.io.IOException"/>
  12480. </method>
  12481. <method name="getRecordReader" return="org.apache.hadoop.mapred.RecordReader"
  12482. abstract="true" native="false" synchronized="false"
  12483. static="false" final="false" visibility="public"
  12484. deprecated="not deprecated">
  12485. <param name="split" type="org.apache.hadoop.mapred.InputSplit"/>
  12486. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  12487. <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
  12488. <exception name="IOException" type="java.io.IOException"/>
  12489. <doc>
  12490. <![CDATA[This is not implemented yet.]]>
  12491. </doc>
  12492. </method>
  12493. <doc>
  12494. <![CDATA[An abstract {@link org.apache.hadoop.mapred.InputFormat} that returns {@link CombineFileSplit}'s
  12495. in {@link org.apache.hadoop.mapred.InputFormat#getSplits(JobConf, int)} method.
  12496. Splits are constructed from the files under the input paths.
  12497. A split cannot have files from different pools.
  12498. Each split returned may contain blocks from different files.
  12499. If a maxSplitSize is specified, then blocks on the same node are
  12500. combined to form a single split. Blocks that are left over are
  12501. then combined with other blocks in the same rack.
  12502. If maxSplitSize is not specified, then blocks from the same rack
  12503. are combined in a single split; no attempt is made to create
  12504. node-local splits.
  12505. If the maxSplitSize is equal to the block size, then this class
  12506. is similar to the default spliting behaviour in Hadoop: each
  12507. block is a locally processed split.
  12508. Subclasses implement {@link org.apache.hadoop.mapred.InputFormat#getRecordReader(InputSplit, JobConf, Reporter)}
  12509. to construct <code>RecordReader</code>'s for <code>CombineFileSplit</code>'s.
  12510. @see CombineFileSplit]]>
  12511. </doc>
  12512. </class>
  12513. <!-- end class org.apache.hadoop.mapred.lib.CombineFileInputFormat -->
  12514. <!-- start class org.apache.hadoop.mapred.lib.CombineFileRecordReader -->
  12515. <class name="CombineFileRecordReader" extends="java.lang.Object"
  12516. abstract="false"
  12517. static="false" final="false" visibility="public"
  12518. deprecated="not deprecated">
  12519. <implements name="org.apache.hadoop.mapred.RecordReader"/>
  12520. <constructor name="CombineFileRecordReader" type="org.apache.hadoop.mapred.JobConf, org.apache.hadoop.mapred.lib.CombineFileSplit, org.apache.hadoop.mapred.Reporter, java.lang.Class"
  12521. static="false" final="false" visibility="public"
  12522. deprecated="not deprecated">
  12523. <exception name="IOException" type="java.io.IOException"/>
  12524. <doc>
  12525. <![CDATA[A generic RecordReader that can hand out different recordReaders
  12526. for each chunk in the CombineFileSplit.]]>
  12527. </doc>
  12528. </constructor>
  12529. <method name="next" return="boolean"
  12530. abstract="false" native="false" synchronized="false"
  12531. static="false" final="false" visibility="public"
  12532. deprecated="not deprecated">
  12533. <param name="key" type="java.lang.Object"/>
  12534. <param name="value" type="java.lang.Object"/>
  12535. <exception name="IOException" type="java.io.IOException"/>
  12536. </method>
  12537. <method name="createKey" return="java.lang.Object"
  12538. abstract="false" native="false" synchronized="false"
  12539. static="false" final="false" visibility="public"
  12540. deprecated="not deprecated">
  12541. </method>
  12542. <method name="createValue" return="java.lang.Object"
  12543. abstract="false" native="false" synchronized="false"
  12544. static="false" final="false" visibility="public"
  12545. deprecated="not deprecated">
  12546. </method>
  12547. <method name="getPos" return="long"
  12548. abstract="false" native="false" synchronized="false"
  12549. static="false" final="false" visibility="public"
  12550. deprecated="not deprecated">
  12551. <exception name="IOException" type="java.io.IOException"/>
  12552. <doc>
  12553. <![CDATA[return the amount of data processed]]>
  12554. </doc>
  12555. </method>
  12556. <method name="close"
  12557. abstract="false" native="false" synchronized="false"
  12558. static="false" final="false" visibility="public"
  12559. deprecated="not deprecated">
  12560. <exception name="IOException" type="java.io.IOException"/>
  12561. </method>
  12562. <method name="getProgress" return="float"
  12563. abstract="false" native="false" synchronized="false"
  12564. static="false" final="false" visibility="public"
  12565. deprecated="not deprecated">
  12566. <exception name="IOException" type="java.io.IOException"/>
  12567. <doc>
  12568. <![CDATA[return progress based on the amount of data processed so far.]]>
  12569. </doc>
  12570. </method>
  12571. <method name="initNextRecordReader" return="boolean"
  12572. abstract="false" native="false" synchronized="false"
  12573. static="false" final="false" visibility="protected"
  12574. deprecated="not deprecated">
  12575. <exception name="IOException" type="java.io.IOException"/>
  12576. <doc>
  12577. <![CDATA[Get the record reader for the next chunk in this CombineFileSplit.]]>
  12578. </doc>
  12579. </method>
  12580. <field name="split" type="org.apache.hadoop.mapred.lib.CombineFileSplit"
  12581. transient="false" volatile="false"
  12582. static="false" final="false" visibility="protected"
  12583. deprecated="not deprecated">
  12584. </field>
  12585. <field name="jc" type="org.apache.hadoop.mapred.JobConf"
  12586. transient="false" volatile="false"
  12587. static="false" final="false" visibility="protected"
  12588. deprecated="not deprecated">
  12589. </field>
  12590. <field name="reporter" type="org.apache.hadoop.mapred.Reporter"
  12591. transient="false" volatile="false"
  12592. static="false" final="false" visibility="protected"
  12593. deprecated="not deprecated">
  12594. </field>
  12595. <field name="rrClass" type="java.lang.Class"
  12596. transient="false" volatile="false"
  12597. static="false" final="false" visibility="protected"
  12598. deprecated="not deprecated">
  12599. </field>
  12600. <field name="rrConstructor" type="java.lang.reflect.Constructor"
  12601. transient="false" volatile="false"
  12602. static="false" final="false" visibility="protected"
  12603. deprecated="not deprecated">
  12604. </field>
  12605. <field name="fs" type="org.apache.hadoop.fs.FileSystem"
  12606. transient="false" volatile="false"
  12607. static="false" final="false" visibility="protected"
  12608. deprecated="not deprecated">
  12609. </field>
  12610. <field name="idx" type="int"
  12611. transient="false" volatile="false"
  12612. static="false" final="false" visibility="protected"
  12613. deprecated="not deprecated">
  12614. </field>
  12615. <field name="progress" type="long"
  12616. transient="false" volatile="false"
  12617. static="false" final="false" visibility="protected"
  12618. deprecated="not deprecated">
  12619. </field>
  12620. <field name="curReader" type="org.apache.hadoop.mapred.RecordReader"
  12621. transient="false" volatile="false"
  12622. static="false" final="false" visibility="protected"
  12623. deprecated="not deprecated">
  12624. </field>
  12625. <doc>
  12626. <![CDATA[A generic RecordReader that can hand out different recordReaders
  12627. for each chunk in a {@link CombineFileSplit}.
  12628. A CombineFileSplit can combine data chunks from multiple files.
  12629. This class allows using different RecordReaders for processing
  12630. these data chunks from different files.
  12631. @see CombineFileSplit]]>
  12632. </doc>
  12633. </class>
  12634. <!-- end class org.apache.hadoop.mapred.lib.CombineFileRecordReader -->
  12635. <!-- start class org.apache.hadoop.mapred.lib.CombineFileSplit -->
  12636. <class name="CombineFileSplit" extends="java.lang.Object"
  12637. abstract="false"
  12638. static="false" final="false" visibility="public"
  12639. deprecated="not deprecated">
  12640. <implements name="org.apache.hadoop.mapred.InputSplit"/>
  12641. <constructor name="CombineFileSplit"
  12642. static="false" final="false" visibility="public"
  12643. deprecated="not deprecated">
  12644. <doc>
  12645. <![CDATA[default constructor]]>
  12646. </doc>
  12647. </constructor>
  12648. <constructor name="CombineFileSplit" type="org.apache.hadoop.mapred.JobConf, org.apache.hadoop.fs.Path[], long[], long[], java.lang.String[]"
  12649. static="false" final="false" visibility="public"
  12650. deprecated="not deprecated">
  12651. </constructor>
  12652. <constructor name="CombineFileSplit" type="org.apache.hadoop.mapred.JobConf, org.apache.hadoop.fs.Path[], long[]"
  12653. static="false" final="false" visibility="public"
  12654. deprecated="not deprecated">
  12655. </constructor>
  12656. <constructor name="CombineFileSplit" type="org.apache.hadoop.mapred.lib.CombineFileSplit"
  12657. static="false" final="false" visibility="public"
  12658. deprecated="not deprecated">
  12659. <exception name="IOException" type="java.io.IOException"/>
  12660. <doc>
  12661. <![CDATA[Copy constructor]]>
  12662. </doc>
  12663. </constructor>
  12664. <method name="getJob" return="org.apache.hadoop.mapred.JobConf"
  12665. abstract="false" native="false" synchronized="false"
  12666. static="false" final="false" visibility="public"
  12667. deprecated="not deprecated">
  12668. </method>
  12669. <method name="getLength" return="long"
  12670. abstract="false" native="false" synchronized="false"
  12671. static="false" final="false" visibility="public"
  12672. deprecated="not deprecated">
  12673. </method>
  12674. <method name="getStartOffsets" return="long[]"
  12675. abstract="false" native="false" synchronized="false"
  12676. static="false" final="false" visibility="public"
  12677. deprecated="not deprecated">
  12678. <doc>
  12679. <![CDATA[Returns an array containing the startoffsets of the files in the split]]>
  12680. </doc>
  12681. </method>
  12682. <method name="getLengths" return="long[]"
  12683. abstract="false" native="false" synchronized="false"
  12684. static="false" final="false" visibility="public"
  12685. deprecated="not deprecated">
  12686. <doc>
  12687. <![CDATA[Returns an array containing the lengths of the files in the split]]>
  12688. </doc>
  12689. </method>
  12690. <method name="getOffset" return="long"
  12691. abstract="false" native="false" synchronized="false"
  12692. static="false" final="false" visibility="public"
  12693. deprecated="not deprecated">
  12694. <param name="i" type="int"/>
  12695. <doc>
  12696. <![CDATA[Returns the start offset of the i<sup>th</sup> Path]]>
  12697. </doc>
  12698. </method>
  12699. <method name="getLength" return="long"
  12700. abstract="false" native="false" synchronized="false"
  12701. static="false" final="false" visibility="public"
  12702. deprecated="not deprecated">
  12703. <param name="i" type="int"/>
  12704. <doc>
  12705. <![CDATA[Returns the length of the i<sup>th</sup> Path]]>
  12706. </doc>
  12707. </method>
  12708. <method name="getNumPaths" return="int"
  12709. abstract="false" native="false" synchronized="false"
  12710. static="false" final="false" visibility="public"
  12711. deprecated="not deprecated">
  12712. <doc>
  12713. <![CDATA[Returns the number of Paths in the split]]>
  12714. </doc>
  12715. </method>
  12716. <method name="getPath" return="org.apache.hadoop.fs.Path"
  12717. abstract="false" native="false" synchronized="false"
  12718. static="false" final="false" visibility="public"
  12719. deprecated="not deprecated">
  12720. <param name="i" type="int"/>
  12721. <doc>
  12722. <![CDATA[Returns the i<sup>th</sup> Path]]>
  12723. </doc>
  12724. </method>
  12725. <method name="getPaths" return="org.apache.hadoop.fs.Path[]"
  12726. abstract="false" native="false" synchronized="false"
  12727. static="false" final="false" visibility="public"
  12728. deprecated="not deprecated">
  12729. <doc>
  12730. <![CDATA[Returns all the Paths in the split]]>
  12731. </doc>
  12732. </method>
  12733. <method name="getLocations" return="java.lang.String[]"
  12734. abstract="false" native="false" synchronized="false"
  12735. static="false" final="false" visibility="public"
  12736. deprecated="not deprecated">
  12737. <exception name="IOException" type="java.io.IOException"/>
  12738. <doc>
  12739. <![CDATA[Returns all the Paths where this input-split resides]]>
  12740. </doc>
  12741. </method>
  12742. <method name="readFields"
  12743. abstract="false" native="false" synchronized="false"
  12744. static="false" final="false" visibility="public"
  12745. deprecated="not deprecated">
  12746. <param name="in" type="java.io.DataInput"/>
  12747. <exception name="IOException" type="java.io.IOException"/>
  12748. </method>
  12749. <method name="write"
  12750. abstract="false" native="false" synchronized="false"
  12751. static="false" final="false" visibility="public"
  12752. deprecated="not deprecated">
  12753. <param name="out" type="java.io.DataOutput"/>
  12754. <exception name="IOException" type="java.io.IOException"/>
  12755. </method>
  12756. <method name="toString" return="java.lang.String"
  12757. abstract="false" native="false" synchronized="false"
  12758. static="false" final="false" visibility="public"
  12759. deprecated="not deprecated">
  12760. </method>
  12761. <doc>
  12762. <![CDATA[A sub-collection of input files. Unlike {@link org.apache.hadoop.mapred.FileSplit},
  12763. CombineFileSplit * class does not represent a split of a file, but a split of input files
  12764. into smaller sets. A split may contain blocks from different file but all
  12765. the blocks in the same split are probably local to some rack <br>
  12766. CombineFileSplit can be used to implement {@link org.apache.hadoop.mapred.RecordReader}'s,
  12767. with reading one record per file.
  12768. @see org.apache.hadoop.mapred.FileSplit
  12769. @see CombineFileInputFormat]]>
  12770. </doc>
  12771. </class>
  12772. <!-- end class org.apache.hadoop.mapred.lib.CombineFileSplit -->
  12773. <!-- start class org.apache.hadoop.mapred.lib.DelegatingInputFormat -->
  12774. <class name="DelegatingInputFormat" extends="java.lang.Object"
  12775. abstract="false"
  12776. static="false" final="false" visibility="public"
  12777. deprecated="not deprecated">
  12778. <implements name="org.apache.hadoop.mapred.InputFormat"/>
  12779. <constructor name="DelegatingInputFormat"
  12780. static="false" final="false" visibility="public"
  12781. deprecated="not deprecated">
  12782. </constructor>
  12783. <method name="getSplits" return="org.apache.hadoop.mapred.InputSplit[]"
  12784. abstract="false" native="false" synchronized="false"
  12785. static="false" final="false" visibility="public"
  12786. deprecated="not deprecated">
  12787. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  12788. <param name="numSplits" type="int"/>
  12789. <exception name="IOException" type="java.io.IOException"/>
  12790. </method>
  12791. <method name="getRecordReader" return="org.apache.hadoop.mapred.RecordReader"
  12792. abstract="false" native="false" synchronized="false"
  12793. static="false" final="false" visibility="public"
  12794. deprecated="not deprecated">
  12795. <param name="split" type="org.apache.hadoop.mapred.InputSplit"/>
  12796. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  12797. <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
  12798. <exception name="IOException" type="java.io.IOException"/>
  12799. </method>
  12800. <doc>
  12801. <![CDATA[An {@link InputFormat} that delegates behaviour of paths to multiple other
  12802. InputFormats.
  12803. @see MultipleInputs#addInputPath(JobConf, Path, Class, Class)]]>
  12804. </doc>
  12805. </class>
  12806. <!-- end class org.apache.hadoop.mapred.lib.DelegatingInputFormat -->
  12807. <!-- start class org.apache.hadoop.mapred.lib.DelegatingMapper -->
  12808. <class name="DelegatingMapper" extends="java.lang.Object"
  12809. abstract="false"
  12810. static="false" final="false" visibility="public"
  12811. deprecated="not deprecated">
  12812. <implements name="org.apache.hadoop.mapred.Mapper"/>
  12813. <constructor name="DelegatingMapper"
  12814. static="false" final="false" visibility="public"
  12815. deprecated="not deprecated">
  12816. </constructor>
  12817. <method name="map"
  12818. abstract="false" native="false" synchronized="false"
  12819. static="false" final="false" visibility="public"
  12820. deprecated="not deprecated">
  12821. <param name="key" type="java.lang.Object"/>
  12822. <param name="value" type="java.lang.Object"/>
  12823. <param name="outputCollector" type="org.apache.hadoop.mapred.OutputCollector"/>
  12824. <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
  12825. <exception name="IOException" type="java.io.IOException"/>
  12826. </method>
  12827. <method name="configure"
  12828. abstract="false" native="false" synchronized="false"
  12829. static="false" final="false" visibility="public"
  12830. deprecated="not deprecated">
  12831. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  12832. </method>
  12833. <method name="close"
  12834. abstract="false" native="false" synchronized="false"
  12835. static="false" final="false" visibility="public"
  12836. deprecated="not deprecated">
  12837. <exception name="IOException" type="java.io.IOException"/>
  12838. </method>
  12839. <doc>
  12840. <![CDATA[An {@link Mapper} that delegates behaviour of paths to multiple other
  12841. mappers.
  12842. @see MultipleInputs#addInputPath(JobConf, Path, Class, Class)]]>
  12843. </doc>
  12844. </class>
  12845. <!-- end class org.apache.hadoop.mapred.lib.DelegatingMapper -->
  12846. <!-- start class org.apache.hadoop.mapred.lib.FieldSelectionMapReduce -->
  12847. <class name="FieldSelectionMapReduce" extends="java.lang.Object"
  12848. abstract="false"
  12849. static="false" final="false" visibility="public"
  12850. deprecated="not deprecated">
  12851. <implements name="org.apache.hadoop.mapred.Mapper"/>
  12852. <implements name="org.apache.hadoop.mapred.Reducer"/>
  12853. <constructor name="FieldSelectionMapReduce"
  12854. static="false" final="false" visibility="public"
  12855. deprecated="not deprecated">
  12856. </constructor>
  12857. <method name="map"
  12858. abstract="false" native="false" synchronized="false"
  12859. static="false" final="false" visibility="public"
  12860. deprecated="not deprecated">
  12861. <param name="key" type="java.lang.Object"/>
  12862. <param name="val" type="java.lang.Object"/>
  12863. <param name="output" type="org.apache.hadoop.mapred.OutputCollector"/>
  12864. <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
  12865. <exception name="IOException" type="java.io.IOException"/>
  12866. <doc>
  12867. <![CDATA[The identify function. Input key/value pair is written directly to output.]]>
  12868. </doc>
  12869. </method>
  12870. <method name="configure"
  12871. abstract="false" native="false" synchronized="false"
  12872. static="false" final="false" visibility="public"
  12873. deprecated="not deprecated">
  12874. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  12875. </method>
  12876. <method name="close"
  12877. abstract="false" native="false" synchronized="false"
  12878. static="false" final="false" visibility="public"
  12879. deprecated="not deprecated">
  12880. <exception name="IOException" type="java.io.IOException"/>
  12881. </method>
  12882. <method name="reduce"
  12883. abstract="false" native="false" synchronized="false"
  12884. static="false" final="false" visibility="public"
  12885. deprecated="not deprecated">
  12886. <param name="key" type="org.apache.hadoop.io.Text"/>
  12887. <param name="values" type="java.util.Iterator"/>
  12888. <param name="output" type="org.apache.hadoop.mapred.OutputCollector"/>
  12889. <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
  12890. <exception name="IOException" type="java.io.IOException"/>
  12891. </method>
  12892. <field name="LOG" type="org.apache.commons.logging.Log"
  12893. transient="false" volatile="false"
  12894. static="true" final="true" visibility="public"
  12895. deprecated="not deprecated">
  12896. </field>
  12897. <doc>
  12898. <![CDATA[This class implements a mapper/reducer class that can be used to perform
  12899. field selections in a manner similar to unix cut. The input data is treated
  12900. as fields separated by a user specified separator (the default value is
  12901. "\t"). The user can specify a list of fields that form the map output keys,
  12902. and a list of fields that form the map output values. If the inputformat is
  12903. TextInputFormat, the mapper will ignore the key to the map function. and the
  12904. fields are from the value only. Otherwise, the fields are the union of those
  12905. from the key and those from the value.
  12906. The field separator is under attribute "mapred.data.field.separator"
  12907. The map output field list spec is under attribute "map.output.key.value.fields.spec".
  12908. The value is expected to be like "keyFieldsSpec:valueFieldsSpec"
  12909. key/valueFieldsSpec are comma (,) separated field spec: fieldSpec,fieldSpec,fieldSpec ...
  12910. Each field spec can be a simple number (e.g. 5) specifying a specific field, or a range
  12911. (like 2-5) to specify a range of fields, or an open range (like 3-) specifying all
  12912. the fields starting from field 3. The open range field spec applies value fields only.
  12913. They have no effect on the key fields.
  12914. Here is an example: "4,3,0,1:6,5,1-3,7-". It specifies to use fields 4,3,0 and 1 for keys,
  12915. and use fields 6,5,1,2,3,7 and above for values.
  12916. The reduce output field list spec is under attribute "reduce.output.key.value.fields.spec".
  12917. The reducer extracts output key/value pairs in a similar manner, except that
  12918. the key is never ignored.]]>
  12919. </doc>
  12920. </class>
  12921. <!-- end class org.apache.hadoop.mapred.lib.FieldSelectionMapReduce -->
  12922. <!-- start class org.apache.hadoop.mapred.lib.HashPartitioner -->
  12923. <class name="HashPartitioner" extends="java.lang.Object"
  12924. abstract="false"
  12925. static="false" final="false" visibility="public"
  12926. deprecated="Use
  12927. {@link org.apache.hadoop.mapreduce.lib.partition.HashPartitioner} instead.">
  12928. <implements name="org.apache.hadoop.mapred.Partitioner"/>
  12929. <constructor name="HashPartitioner"
  12930. static="false" final="false" visibility="public"
  12931. deprecated="not deprecated">
  12932. </constructor>
  12933. <method name="configure"
  12934. abstract="false" native="false" synchronized="false"
  12935. static="false" final="false" visibility="public"
  12936. deprecated="not deprecated">
  12937. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  12938. </method>
  12939. <method name="getPartition" return="int"
  12940. abstract="false" native="false" synchronized="false"
  12941. static="false" final="false" visibility="public"
  12942. deprecated="not deprecated">
  12943. <param name="key" type="java.lang.Object"/>
  12944. <param name="value" type="java.lang.Object"/>
  12945. <param name="numReduceTasks" type="int"/>
  12946. <doc>
  12947. <![CDATA[Use {@link Object#hashCode()} to partition.]]>
  12948. </doc>
  12949. </method>
  12950. <doc>
  12951. <![CDATA[Partition keys by their {@link Object#hashCode()}.
  12952. @deprecated Use
  12953. {@link org.apache.hadoop.mapreduce.lib.partition.HashPartitioner} instead.]]>
  12954. </doc>
  12955. </class>
  12956. <!-- end class org.apache.hadoop.mapred.lib.HashPartitioner -->
  12957. <!-- start class org.apache.hadoop.mapred.lib.IdentityMapper -->
  12958. <class name="IdentityMapper" extends="org.apache.hadoop.mapred.MapReduceBase"
  12959. abstract="false"
  12960. static="false" final="false" visibility="public"
  12961. deprecated="Use {@link org.apache.hadoop.mapreduce.Mapper} instead.">
  12962. <implements name="org.apache.hadoop.mapred.Mapper"/>
  12963. <constructor name="IdentityMapper"
  12964. static="false" final="false" visibility="public"
  12965. deprecated="not deprecated">
  12966. </constructor>
  12967. <method name="map"
  12968. abstract="false" native="false" synchronized="false"
  12969. static="false" final="false" visibility="public"
  12970. deprecated="not deprecated">
  12971. <param name="key" type="java.lang.Object"/>
  12972. <param name="val" type="java.lang.Object"/>
  12973. <param name="output" type="org.apache.hadoop.mapred.OutputCollector"/>
  12974. <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
  12975. <exception name="IOException" type="java.io.IOException"/>
  12976. <doc>
  12977. <![CDATA[The identify function. Input key/value pair is written directly to
  12978. output.]]>
  12979. </doc>
  12980. </method>
  12981. <doc>
  12982. <![CDATA[Implements the identity function, mapping inputs directly to outputs.
  12983. @deprecated Use {@link org.apache.hadoop.mapreduce.Mapper} instead.]]>
  12984. </doc>
  12985. </class>
  12986. <!-- end class org.apache.hadoop.mapred.lib.IdentityMapper -->
  12987. <!-- start class org.apache.hadoop.mapred.lib.IdentityReducer -->
  12988. <class name="IdentityReducer" extends="org.apache.hadoop.mapred.MapReduceBase"
  12989. abstract="false"
  12990. static="false" final="false" visibility="public"
  12991. deprecated="Use {@link org.apache.hadoop.mapreduce.Reducer} instead.">
  12992. <implements name="org.apache.hadoop.mapred.Reducer"/>
  12993. <constructor name="IdentityReducer"
  12994. static="false" final="false" visibility="public"
  12995. deprecated="not deprecated">
  12996. </constructor>
  12997. <method name="reduce"
  12998. abstract="false" native="false" synchronized="false"
  12999. static="false" final="false" visibility="public"
  13000. deprecated="not deprecated">
  13001. <param name="key" type="java.lang.Object"/>
  13002. <param name="values" type="java.util.Iterator"/>
  13003. <param name="output" type="org.apache.hadoop.mapred.OutputCollector"/>
  13004. <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
  13005. <exception name="IOException" type="java.io.IOException"/>
  13006. <doc>
  13007. <![CDATA[Writes all keys and values directly to output.]]>
  13008. </doc>
  13009. </method>
  13010. <doc>
  13011. <![CDATA[Performs no reduction, writing all input values directly to the output.
  13012. @deprecated Use {@link org.apache.hadoop.mapreduce.Reducer} instead.]]>
  13013. </doc>
  13014. </class>
  13015. <!-- end class org.apache.hadoop.mapred.lib.IdentityReducer -->
  13016. <!-- start class org.apache.hadoop.mapred.lib.InputSampler -->
  13017. <class name="InputSampler" extends="java.lang.Object"
  13018. abstract="false"
  13019. static="false" final="false" visibility="public"
  13020. deprecated="not deprecated">
  13021. <implements name="org.apache.hadoop.util.Tool"/>
  13022. <constructor name="InputSampler" type="org.apache.hadoop.mapred.JobConf"
  13023. static="false" final="false" visibility="public"
  13024. deprecated="not deprecated">
  13025. </constructor>
  13026. <method name="getConf" return="org.apache.hadoop.conf.Configuration"
  13027. abstract="false" native="false" synchronized="false"
  13028. static="false" final="false" visibility="public"
  13029. deprecated="not deprecated">
  13030. </method>
  13031. <method name="setConf"
  13032. abstract="false" native="false" synchronized="false"
  13033. static="false" final="false" visibility="public"
  13034. deprecated="not deprecated">
  13035. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  13036. </method>
  13037. <method name="writePartitionFile"
  13038. abstract="false" native="false" synchronized="false"
  13039. static="true" final="false" visibility="public"
  13040. deprecated="not deprecated">
  13041. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  13042. <param name="sampler" type="org.apache.hadoop.mapred.lib.InputSampler.Sampler"/>
  13043. <exception name="IOException" type="java.io.IOException"/>
  13044. <doc>
  13045. <![CDATA[Write a partition file for the given job, using the Sampler provided.
  13046. Queries the sampler for a sample keyset, sorts by the output key
  13047. comparator, selects the keys for each rank, and writes to the destination
  13048. returned from {@link
  13049. org.apache.hadoop.mapred.lib.TotalOrderPartitioner#getPartitionFile}.]]>
  13050. </doc>
  13051. </method>
  13052. <method name="run" return="int"
  13053. abstract="false" native="false" synchronized="false"
  13054. static="false" final="false" visibility="public"
  13055. deprecated="not deprecated">
  13056. <param name="args" type="java.lang.String[]"/>
  13057. <exception name="Exception" type="java.lang.Exception"/>
  13058. <doc>
  13059. <![CDATA[Driver for InputSampler from the command line.
  13060. Configures a JobConf instance and calls {@link #writePartitionFile}.]]>
  13061. </doc>
  13062. </method>
  13063. <method name="main"
  13064. abstract="false" native="false" synchronized="false"
  13065. static="true" final="false" visibility="public"
  13066. deprecated="not deprecated">
  13067. <param name="args" type="java.lang.String[]"/>
  13068. <exception name="Exception" type="java.lang.Exception"/>
  13069. </method>
  13070. <doc>
  13071. <![CDATA[Utility for collecting samples and writing a partition file for
  13072. {@link org.apache.hadoop.mapred.lib.TotalOrderPartitioner}.]]>
  13073. </doc>
  13074. </class>
  13075. <!-- end class org.apache.hadoop.mapred.lib.InputSampler -->
  13076. <!-- start class org.apache.hadoop.mapred.lib.InputSampler.IntervalSampler -->
  13077. <class name="InputSampler.IntervalSampler" extends="java.lang.Object"
  13078. abstract="false"
  13079. static="true" final="false" visibility="public"
  13080. deprecated="not deprecated">
  13081. <implements name="org.apache.hadoop.mapred.lib.InputSampler.Sampler"/>
  13082. <constructor name="InputSampler.IntervalSampler" type="double"
  13083. static="false" final="false" visibility="public"
  13084. deprecated="not deprecated">
  13085. <doc>
  13086. <![CDATA[Create a new IntervalSampler sampling <em>all</em> splits.
  13087. @param freq The frequency with which records will be emitted.]]>
  13088. </doc>
  13089. </constructor>
  13090. <constructor name="InputSampler.IntervalSampler" type="double, int"
  13091. static="false" final="false" visibility="public"
  13092. deprecated="not deprecated">
  13093. <doc>
  13094. <![CDATA[Create a new IntervalSampler.
  13095. @param freq The frequency with which records will be emitted.
  13096. @param maxSplitsSampled The maximum number of splits to examine.
  13097. @see #getSample]]>
  13098. </doc>
  13099. </constructor>
  13100. <method name="getSample" return="java.lang.Object[]"
  13101. abstract="false" native="false" synchronized="false"
  13102. static="false" final="false" visibility="public"
  13103. deprecated="not deprecated">
  13104. <param name="inf" type="org.apache.hadoop.mapred.InputFormat"/>
  13105. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  13106. <exception name="IOException" type="java.io.IOException"/>
  13107. <doc>
  13108. <![CDATA[For each split sampled, emit when the ratio of the number of records
  13109. retained to the total record count is less than the specified
  13110. frequency.]]>
  13111. </doc>
  13112. </method>
  13113. <doc>
  13114. <![CDATA[Sample from s splits at regular intervals.
  13115. Useful for sorted data.]]>
  13116. </doc>
  13117. </class>
  13118. <!-- end class org.apache.hadoop.mapred.lib.InputSampler.IntervalSampler -->
  13119. <!-- start class org.apache.hadoop.mapred.lib.InputSampler.RandomSampler -->
  13120. <class name="InputSampler.RandomSampler" extends="java.lang.Object"
  13121. abstract="false"
  13122. static="true" final="false" visibility="public"
  13123. deprecated="not deprecated">
  13124. <implements name="org.apache.hadoop.mapred.lib.InputSampler.Sampler"/>
  13125. <constructor name="InputSampler.RandomSampler" type="double, int"
  13126. static="false" final="false" visibility="public"
  13127. deprecated="not deprecated">
  13128. <doc>
  13129. <![CDATA[Create a new RandomSampler sampling <em>all</em> splits.
  13130. This will read every split at the client, which is very expensive.
  13131. @param freq Probability with which a key will be chosen.
  13132. @param numSamples Total number of samples to obtain from all selected
  13133. splits.]]>
  13134. </doc>
  13135. </constructor>
  13136. <constructor name="InputSampler.RandomSampler" type="double, int, int"
  13137. static="false" final="false" visibility="public"
  13138. deprecated="not deprecated">
  13139. <doc>
  13140. <![CDATA[Create a new RandomSampler.
  13141. @param freq Probability with which a key will be chosen.
  13142. @param numSamples Total number of samples to obtain from all selected
  13143. splits.
  13144. @param maxSplitsSampled The maximum number of splits to examine.]]>
  13145. </doc>
  13146. </constructor>
  13147. <method name="getSample" return="java.lang.Object[]"
  13148. abstract="false" native="false" synchronized="false"
  13149. static="false" final="false" visibility="public"
  13150. deprecated="not deprecated">
  13151. <param name="inf" type="org.apache.hadoop.mapred.InputFormat"/>
  13152. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  13153. <exception name="IOException" type="java.io.IOException"/>
  13154. <doc>
  13155. <![CDATA[Randomize the split order, then take the specified number of keys from
  13156. each split sampled, where each key is selected with the specified
  13157. probability and possibly replaced by a subsequently selected key when
  13158. the quota of keys from that split is satisfied.]]>
  13159. </doc>
  13160. </method>
  13161. <doc>
  13162. <![CDATA[Sample from random points in the input.
  13163. General-purpose sampler. Takes numSamples / maxSplitsSampled inputs from
  13164. each split.]]>
  13165. </doc>
  13166. </class>
  13167. <!-- end class org.apache.hadoop.mapred.lib.InputSampler.RandomSampler -->
  13168. <!-- start interface org.apache.hadoop.mapred.lib.InputSampler.Sampler -->
  13169. <interface name="InputSampler.Sampler" abstract="true"
  13170. static="true" final="false" visibility="public"
  13171. deprecated="not deprecated">
  13172. <method name="getSample" return="java.lang.Object[]"
  13173. abstract="false" native="false" synchronized="false"
  13174. static="false" final="false" visibility="public"
  13175. deprecated="not deprecated">
  13176. <param name="inf" type="org.apache.hadoop.mapred.InputFormat"/>
  13177. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  13178. <exception name="IOException" type="java.io.IOException"/>
  13179. <doc>
  13180. <![CDATA[For a given job, collect and return a subset of the keys from the
  13181. input data.]]>
  13182. </doc>
  13183. </method>
  13184. <doc>
  13185. <![CDATA[Interface to sample using an {@link org.apache.hadoop.mapred.InputFormat}.]]>
  13186. </doc>
  13187. </interface>
  13188. <!-- end interface org.apache.hadoop.mapred.lib.InputSampler.Sampler -->
  13189. <!-- start class org.apache.hadoop.mapred.lib.InputSampler.SplitSampler -->
  13190. <class name="InputSampler.SplitSampler" extends="java.lang.Object"
  13191. abstract="false"
  13192. static="true" final="false" visibility="public"
  13193. deprecated="not deprecated">
  13194. <implements name="org.apache.hadoop.mapred.lib.InputSampler.Sampler"/>
  13195. <constructor name="InputSampler.SplitSampler" type="int"
  13196. static="false" final="false" visibility="public"
  13197. deprecated="not deprecated">
  13198. <doc>
  13199. <![CDATA[Create a SplitSampler sampling <em>all</em> splits.
  13200. Takes the first numSamples / numSplits records from each split.
  13201. @param numSamples Total number of samples to obtain from all selected
  13202. splits.]]>
  13203. </doc>
  13204. </constructor>
  13205. <constructor name="InputSampler.SplitSampler" type="int, int"
  13206. static="false" final="false" visibility="public"
  13207. deprecated="not deprecated">
  13208. <doc>
  13209. <![CDATA[Create a new SplitSampler.
  13210. @param numSamples Total number of samples to obtain from all selected
  13211. splits.
  13212. @param maxSplitsSampled The maximum number of splits to examine.]]>
  13213. </doc>
  13214. </constructor>
  13215. <method name="getSample" return="java.lang.Object[]"
  13216. abstract="false" native="false" synchronized="false"
  13217. static="false" final="false" visibility="public"
  13218. deprecated="not deprecated">
  13219. <param name="inf" type="org.apache.hadoop.mapred.InputFormat"/>
  13220. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  13221. <exception name="IOException" type="java.io.IOException"/>
  13222. <doc>
  13223. <![CDATA[From each split sampled, take the first numSamples / numSplits records.]]>
  13224. </doc>
  13225. </method>
  13226. <doc>
  13227. <![CDATA[Samples the first n records from s splits.
  13228. Inexpensive way to sample random data.]]>
  13229. </doc>
  13230. </class>
  13231. <!-- end class org.apache.hadoop.mapred.lib.InputSampler.SplitSampler -->
  13232. <!-- start class org.apache.hadoop.mapred.lib.InverseMapper -->
  13233. <class name="InverseMapper" extends="org.apache.hadoop.mapred.MapReduceBase"
  13234. abstract="false"
  13235. static="false" final="false" visibility="public"
  13236. deprecated="Use {@link org.apache.hadoop.mapreduce.lib.map.InverseMapper}
  13237. instead.">
  13238. <implements name="org.apache.hadoop.mapred.Mapper"/>
  13239. <constructor name="InverseMapper"
  13240. static="false" final="false" visibility="public"
  13241. deprecated="not deprecated">
  13242. </constructor>
  13243. <method name="map"
  13244. abstract="false" native="false" synchronized="false"
  13245. static="false" final="false" visibility="public"
  13246. deprecated="not deprecated">
  13247. <param name="key" type="java.lang.Object"/>
  13248. <param name="value" type="java.lang.Object"/>
  13249. <param name="output" type="org.apache.hadoop.mapred.OutputCollector"/>
  13250. <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
  13251. <exception name="IOException" type="java.io.IOException"/>
  13252. <doc>
  13253. <![CDATA[The inverse function. Input keys and values are swapped.]]>
  13254. </doc>
  13255. </method>
  13256. <doc>
  13257. <![CDATA[A {@link Mapper} that swaps keys and values.
  13258. @deprecated Use {@link org.apache.hadoop.mapreduce.lib.map.InverseMapper}
  13259. instead.]]>
  13260. </doc>
  13261. </class>
  13262. <!-- end class org.apache.hadoop.mapred.lib.InverseMapper -->
  13263. <!-- start class org.apache.hadoop.mapred.lib.KeyFieldBasedComparator -->
  13264. <class name="KeyFieldBasedComparator" extends="org.apache.hadoop.io.WritableComparator"
  13265. abstract="false"
  13266. static="false" final="false" visibility="public"
  13267. deprecated="not deprecated">
  13268. <implements name="org.apache.hadoop.mapred.JobConfigurable"/>
  13269. <constructor name="KeyFieldBasedComparator"
  13270. static="false" final="false" visibility="public"
  13271. deprecated="not deprecated">
  13272. </constructor>
  13273. <method name="configure"
  13274. abstract="false" native="false" synchronized="false"
  13275. static="false" final="false" visibility="public"
  13276. deprecated="not deprecated">
  13277. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  13278. </method>
  13279. <method name="compare" return="int"
  13280. abstract="false" native="false" synchronized="false"
  13281. static="false" final="false" visibility="public"
  13282. deprecated="not deprecated">
  13283. <param name="b1" type="byte[]"/>
  13284. <param name="s1" type="int"/>
  13285. <param name="l1" type="int"/>
  13286. <param name="b2" type="byte[]"/>
  13287. <param name="s2" type="int"/>
  13288. <param name="l2" type="int"/>
  13289. </method>
  13290. <doc>
  13291. <![CDATA[This comparator implementation provides a subset of the features provided
  13292. by the Unix/GNU Sort. In particular, the supported features are:
  13293. -n, (Sort numerically)
  13294. -r, (Reverse the result of comparison)
  13295. -k pos1[,pos2], where pos is of the form f[.c][opts], where f is the number
  13296. of the field to use, and c is the number of the first character from the
  13297. beginning of the field. Fields and character posns are numbered starting
  13298. with 1; a character position of zero in pos2 indicates the field's last
  13299. character. If '.c' is omitted from pos1, it defaults to 1 (the beginning
  13300. of the field); if omitted from pos2, it defaults to 0 (the end of the
  13301. field). opts are ordering options (any of 'nr' as described above).
  13302. We assume that the fields in the key are separated by
  13303. map.output.key.field.separator.]]>
  13304. </doc>
  13305. </class>
  13306. <!-- end class org.apache.hadoop.mapred.lib.KeyFieldBasedComparator -->
  13307. <!-- start class org.apache.hadoop.mapred.lib.KeyFieldBasedPartitioner -->
  13308. <class name="KeyFieldBasedPartitioner" extends="java.lang.Object"
  13309. abstract="false"
  13310. static="false" final="false" visibility="public"
  13311. deprecated="not deprecated">
  13312. <implements name="org.apache.hadoop.mapred.Partitioner"/>
  13313. <constructor name="KeyFieldBasedPartitioner"
  13314. static="false" final="false" visibility="public"
  13315. deprecated="not deprecated">
  13316. </constructor>
  13317. <method name="configure"
  13318. abstract="false" native="false" synchronized="false"
  13319. static="false" final="false" visibility="public"
  13320. deprecated="not deprecated">
  13321. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  13322. </method>
  13323. <method name="getPartition" return="int"
  13324. abstract="false" native="false" synchronized="false"
  13325. static="false" final="false" visibility="public"
  13326. deprecated="not deprecated">
  13327. <param name="key" type="java.lang.Object"/>
  13328. <param name="value" type="java.lang.Object"/>
  13329. <param name="numReduceTasks" type="int"/>
  13330. </method>
  13331. <method name="hashCode" return="int"
  13332. abstract="false" native="false" synchronized="false"
  13333. static="false" final="false" visibility="protected"
  13334. deprecated="not deprecated">
  13335. <param name="b" type="byte[]"/>
  13336. <param name="start" type="int"/>
  13337. <param name="end" type="int"/>
  13338. <param name="currentHash" type="int"/>
  13339. </method>
  13340. <doc>
  13341. <![CDATA[Defines a way to partition keys based on certain key fields (also see
  13342. {@link KeyFieldBasedComparator}.
  13343. The key specification supported is of the form -k pos1[,pos2], where,
  13344. pos is of the form f[.c][opts], where f is the number
  13345. of the key field to use, and c is the number of the first character from
  13346. the beginning of the field. Fields and character posns are numbered
  13347. starting with 1; a character position of zero in pos2 indicates the
  13348. field's last character. If '.c' is omitted from pos1, it defaults to 1
  13349. (the beginning of the field); if omitted from pos2, it defaults to 0
  13350. (the end of the field).]]>
  13351. </doc>
  13352. </class>
  13353. <!-- end class org.apache.hadoop.mapred.lib.KeyFieldBasedPartitioner -->
  13354. <!-- start class org.apache.hadoop.mapred.lib.LongSumReducer -->
  13355. <class name="LongSumReducer" extends="org.apache.hadoop.mapred.MapReduceBase"
  13356. abstract="false"
  13357. static="false" final="false" visibility="public"
  13358. deprecated="Use {@link org.apache.hadoop.mapreduce.lib.reduce.LongSumReducer}
  13359. instead.">
  13360. <implements name="org.apache.hadoop.mapred.Reducer"/>
  13361. <constructor name="LongSumReducer"
  13362. static="false" final="false" visibility="public"
  13363. deprecated="not deprecated">
  13364. </constructor>
  13365. <method name="reduce"
  13366. abstract="false" native="false" synchronized="false"
  13367. static="false" final="false" visibility="public"
  13368. deprecated="not deprecated">
  13369. <param name="key" type="java.lang.Object"/>
  13370. <param name="values" type="java.util.Iterator"/>
  13371. <param name="output" type="org.apache.hadoop.mapred.OutputCollector"/>
  13372. <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
  13373. <exception name="IOException" type="java.io.IOException"/>
  13374. </method>
  13375. <doc>
  13376. <![CDATA[A {@link Reducer} that sums long values.
  13377. @deprecated Use {@link org.apache.hadoop.mapreduce.lib.reduce.LongSumReducer}
  13378. instead.]]>
  13379. </doc>
  13380. </class>
  13381. <!-- end class org.apache.hadoop.mapred.lib.LongSumReducer -->
  13382. <!-- start class org.apache.hadoop.mapred.lib.MultipleInputs -->
  13383. <class name="MultipleInputs" extends="java.lang.Object"
  13384. abstract="false"
  13385. static="false" final="false" visibility="public"
  13386. deprecated="not deprecated">
  13387. <constructor name="MultipleInputs"
  13388. static="false" final="false" visibility="public"
  13389. deprecated="not deprecated">
  13390. </constructor>
  13391. <method name="addInputPath"
  13392. abstract="false" native="false" synchronized="false"
  13393. static="true" final="false" visibility="public"
  13394. deprecated="not deprecated">
  13395. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  13396. <param name="path" type="org.apache.hadoop.fs.Path"/>
  13397. <param name="inputFormatClass" type="java.lang.Class"/>
  13398. <doc>
  13399. <![CDATA[Add a {@link Path} with a custom {@link InputFormat} to the list of
  13400. inputs for the map-reduce job.
  13401. @param conf The configuration of the job
  13402. @param path {@link Path} to be added to the list of inputs for the job
  13403. @param inputFormatClass {@link InputFormat} class to use for this path]]>
  13404. </doc>
  13405. </method>
  13406. <method name="addInputPath"
  13407. abstract="false" native="false" synchronized="false"
  13408. static="true" final="false" visibility="public"
  13409. deprecated="not deprecated">
  13410. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  13411. <param name="path" type="org.apache.hadoop.fs.Path"/>
  13412. <param name="inputFormatClass" type="java.lang.Class"/>
  13413. <param name="mapperClass" type="java.lang.Class"/>
  13414. <doc>
  13415. <![CDATA[Add a {@link Path} with a custom {@link InputFormat} and
  13416. {@link Mapper} to the list of inputs for the map-reduce job.
  13417. @param conf The configuration of the job
  13418. @param path {@link Path} to be added to the list of inputs for the job
  13419. @param inputFormatClass {@link InputFormat} class to use for this path
  13420. @param mapperClass {@link Mapper} class to use for this path]]>
  13421. </doc>
  13422. </method>
  13423. <doc>
  13424. <![CDATA[This class supports MapReduce jobs that have multiple input paths with
  13425. a different {@link InputFormat} and {@link Mapper} for each path]]>
  13426. </doc>
  13427. </class>
  13428. <!-- end class org.apache.hadoop.mapred.lib.MultipleInputs -->
  13429. <!-- start class org.apache.hadoop.mapred.lib.MultipleOutputFormat -->
  13430. <class name="MultipleOutputFormat" extends="org.apache.hadoop.mapred.FileOutputFormat"
  13431. abstract="true"
  13432. static="false" final="false" visibility="public"
  13433. deprecated="not deprecated">
  13434. <constructor name="MultipleOutputFormat"
  13435. static="false" final="false" visibility="public"
  13436. deprecated="not deprecated">
  13437. </constructor>
  13438. <method name="getRecordWriter" return="org.apache.hadoop.mapred.RecordWriter"
  13439. abstract="false" native="false" synchronized="false"
  13440. static="false" final="false" visibility="public"
  13441. deprecated="not deprecated">
  13442. <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
  13443. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  13444. <param name="name" type="java.lang.String"/>
  13445. <param name="arg3" type="org.apache.hadoop.util.Progressable"/>
  13446. <exception name="IOException" type="java.io.IOException"/>
  13447. <doc>
  13448. <![CDATA[Create a composite record writer that can write key/value data to different
  13449. output files
  13450. @param fs
  13451. the file system to use
  13452. @param job
  13453. the job conf for the job
  13454. @param name
  13455. the leaf file name for the output file (such as part-00000")
  13456. @param arg3
  13457. a progressable for reporting progress.
  13458. @return a composite record writer
  13459. @throws IOException]]>
  13460. </doc>
  13461. </method>
  13462. <method name="generateLeafFileName" return="java.lang.String"
  13463. abstract="false" native="false" synchronized="false"
  13464. static="false" final="false" visibility="protected"
  13465. deprecated="not deprecated">
  13466. <param name="name" type="java.lang.String"/>
  13467. <doc>
  13468. <![CDATA[Generate the leaf name for the output file name. The default behavior does
  13469. not change the leaf file name (such as part-00000)
  13470. @param name
  13471. the leaf file name for the output file
  13472. @return the given leaf file name]]>
  13473. </doc>
  13474. </method>
  13475. <method name="generateFileNameForKeyValue" return="java.lang.String"
  13476. abstract="false" native="false" synchronized="false"
  13477. static="false" final="false" visibility="protected"
  13478. deprecated="not deprecated">
  13479. <param name="key" type="java.lang.Object"/>
  13480. <param name="value" type="java.lang.Object"/>
  13481. <param name="name" type="java.lang.String"/>
  13482. <doc>
  13483. <![CDATA[Generate the file output file name based on the given key and the leaf file
  13484. name. The default behavior is that the file name does not depend on the
  13485. key.
  13486. @param key
  13487. the key of the output data
  13488. @param name
  13489. the leaf file name
  13490. @return generated file name]]>
  13491. </doc>
  13492. </method>
  13493. <method name="generateActualKey" return="java.lang.Object"
  13494. abstract="false" native="false" synchronized="false"
  13495. static="false" final="false" visibility="protected"
  13496. deprecated="not deprecated">
  13497. <param name="key" type="java.lang.Object"/>
  13498. <param name="value" type="java.lang.Object"/>
  13499. <doc>
  13500. <![CDATA[Generate the actual key from the given key/value. The default behavior is that
  13501. the actual key is equal to the given key
  13502. @param key
  13503. the key of the output data
  13504. @param value
  13505. the value of the output data
  13506. @return the actual key derived from the given key/value]]>
  13507. </doc>
  13508. </method>
  13509. <method name="generateActualValue" return="java.lang.Object"
  13510. abstract="false" native="false" synchronized="false"
  13511. static="false" final="false" visibility="protected"
  13512. deprecated="not deprecated">
  13513. <param name="key" type="java.lang.Object"/>
  13514. <param name="value" type="java.lang.Object"/>
  13515. <doc>
  13516. <![CDATA[Generate the actual value from the given key and value. The default behavior is that
  13517. the actual value is equal to the given value
  13518. @param key
  13519. the key of the output data
  13520. @param value
  13521. the value of the output data
  13522. @return the actual value derived from the given key/value]]>
  13523. </doc>
  13524. </method>
  13525. <method name="getInputFileBasedOutputFileName" return="java.lang.String"
  13526. abstract="false" native="false" synchronized="false"
  13527. static="false" final="false" visibility="protected"
  13528. deprecated="not deprecated">
  13529. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  13530. <param name="name" type="java.lang.String"/>
  13531. <doc>
  13532. <![CDATA[Generate the outfile name based on a given anme and the input file name. If
  13533. the map input file does not exists (i.e. this is not for a map only job),
  13534. the given name is returned unchanged. If the config value for
  13535. "num.of.trailing.legs.to.use" is not set, or set 0 or negative, the given
  13536. name is returned unchanged. Otherwise, return a file name consisting of the
  13537. N trailing legs of the input file name where N is the config value for
  13538. "num.of.trailing.legs.to.use".
  13539. @param job
  13540. the job config
  13541. @param name
  13542. the output file name
  13543. @return the outfile name based on a given anme and the input file name.]]>
  13544. </doc>
  13545. </method>
  13546. <method name="getBaseRecordWriter" return="org.apache.hadoop.mapred.RecordWriter"
  13547. abstract="true" native="false" synchronized="false"
  13548. static="false" final="false" visibility="protected"
  13549. deprecated="not deprecated">
  13550. <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
  13551. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  13552. <param name="name" type="java.lang.String"/>
  13553. <param name="arg3" type="org.apache.hadoop.util.Progressable"/>
  13554. <exception name="IOException" type="java.io.IOException"/>
  13555. <doc>
  13556. <![CDATA[@param fs
  13557. the file system to use
  13558. @param job
  13559. a job conf object
  13560. @param name
  13561. the name of the file over which a record writer object will be
  13562. constructed
  13563. @param arg3
  13564. a progressable object
  13565. @return A RecordWriter object over the given file
  13566. @throws IOException]]>
  13567. </doc>
  13568. </method>
  13569. <doc>
  13570. <![CDATA[This abstract class extends the FileOutputFormat, allowing to write the
  13571. output data to different output files. There are three basic use cases for
  13572. this class.
  13573. Case one: This class is used for a map reduce job with at least one reducer.
  13574. The reducer wants to write data to different files depending on the actual
  13575. keys. It is assumed that a key (or value) encodes the actual key (value)
  13576. and the desired location for the actual key (value).
  13577. Case two: This class is used for a map only job. The job wants to use an
  13578. output file name that is either a part of the input file name of the input
  13579. data, or some derivation of it.
  13580. Case three: This class is used for a map only job. The job wants to use an
  13581. output file name that depends on both the keys and the input file name,]]>
  13582. </doc>
  13583. </class>
  13584. <!-- end class org.apache.hadoop.mapred.lib.MultipleOutputFormat -->
  13585. <!-- start class org.apache.hadoop.mapred.lib.MultipleOutputs -->
  13586. <class name="MultipleOutputs" extends="java.lang.Object"
  13587. abstract="false"
  13588. static="false" final="false" visibility="public"
  13589. deprecated="not deprecated">
  13590. <constructor name="MultipleOutputs" type="org.apache.hadoop.mapred.JobConf"
  13591. static="false" final="false" visibility="public"
  13592. deprecated="not deprecated">
  13593. <doc>
  13594. <![CDATA[Creates and initializes multiple named outputs support, it should be
  13595. instantiated in the Mapper/Reducer configure method.
  13596. @param job the job configuration object]]>
  13597. </doc>
  13598. </constructor>
  13599. <method name="getNamedOutputsList" return="java.util.List"
  13600. abstract="false" native="false" synchronized="false"
  13601. static="true" final="false" visibility="public"
  13602. deprecated="not deprecated">
  13603. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  13604. <doc>
  13605. <![CDATA[Returns list of channel names.
  13606. @param conf job conf
  13607. @return List of channel Names]]>
  13608. </doc>
  13609. </method>
  13610. <method name="isMultiNamedOutput" return="boolean"
  13611. abstract="false" native="false" synchronized="false"
  13612. static="true" final="false" visibility="public"
  13613. deprecated="not deprecated">
  13614. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  13615. <param name="namedOutput" type="java.lang.String"/>
  13616. <doc>
  13617. <![CDATA[Returns if a named output is multiple.
  13618. @param conf job conf
  13619. @param namedOutput named output
  13620. @return <code>true</code> if the name output is multi, <code>false</code>
  13621. if it is single. If the name output is not defined it returns
  13622. <code>false</code>]]>
  13623. </doc>
  13624. </method>
  13625. <method name="getNamedOutputFormatClass" return="java.lang.Class"
  13626. abstract="false" native="false" synchronized="false"
  13627. static="true" final="false" visibility="public"
  13628. deprecated="not deprecated">
  13629. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  13630. <param name="namedOutput" type="java.lang.String"/>
  13631. <doc>
  13632. <![CDATA[Returns the named output OutputFormat.
  13633. @param conf job conf
  13634. @param namedOutput named output
  13635. @return namedOutput OutputFormat]]>
  13636. </doc>
  13637. </method>
  13638. <method name="getNamedOutputKeyClass" return="java.lang.Class"
  13639. abstract="false" native="false" synchronized="false"
  13640. static="true" final="false" visibility="public"
  13641. deprecated="not deprecated">
  13642. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  13643. <param name="namedOutput" type="java.lang.String"/>
  13644. <doc>
  13645. <![CDATA[Returns the key class for a named output.
  13646. @param conf job conf
  13647. @param namedOutput named output
  13648. @return class for the named output key]]>
  13649. </doc>
  13650. </method>
  13651. <method name="getNamedOutputValueClass" return="java.lang.Class"
  13652. abstract="false" native="false" synchronized="false"
  13653. static="true" final="false" visibility="public"
  13654. deprecated="not deprecated">
  13655. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  13656. <param name="namedOutput" type="java.lang.String"/>
  13657. <doc>
  13658. <![CDATA[Returns the value class for a named output.
  13659. @param conf job conf
  13660. @param namedOutput named output
  13661. @return class of named output value]]>
  13662. </doc>
  13663. </method>
  13664. <method name="addNamedOutput"
  13665. abstract="false" native="false" synchronized="false"
  13666. static="true" final="false" visibility="public"
  13667. deprecated="not deprecated">
  13668. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  13669. <param name="namedOutput" type="java.lang.String"/>
  13670. <param name="outputFormatClass" type="java.lang.Class"/>
  13671. <param name="keyClass" type="java.lang.Class"/>
  13672. <param name="valueClass" type="java.lang.Class"/>
  13673. <doc>
  13674. <![CDATA[Adds a named output for the job.
  13675. <p/>
  13676. @param conf job conf to add the named output
  13677. @param namedOutput named output name, it has to be a word, letters
  13678. and numbers only, cannot be the word 'part' as
  13679. that is reserved for the
  13680. default output.
  13681. @param outputFormatClass OutputFormat class.
  13682. @param keyClass key class
  13683. @param valueClass value class]]>
  13684. </doc>
  13685. </method>
  13686. <method name="addMultiNamedOutput"
  13687. abstract="false" native="false" synchronized="false"
  13688. static="true" final="false" visibility="public"
  13689. deprecated="not deprecated">
  13690. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  13691. <param name="namedOutput" type="java.lang.String"/>
  13692. <param name="outputFormatClass" type="java.lang.Class"/>
  13693. <param name="keyClass" type="java.lang.Class"/>
  13694. <param name="valueClass" type="java.lang.Class"/>
  13695. <doc>
  13696. <![CDATA[Adds a multi named output for the job.
  13697. <p/>
  13698. @param conf job conf to add the named output
  13699. @param namedOutput named output name, it has to be a word, letters
  13700. and numbers only, cannot be the word 'part' as
  13701. that is reserved for the
  13702. default output.
  13703. @param outputFormatClass OutputFormat class.
  13704. @param keyClass key class
  13705. @param valueClass value class]]>
  13706. </doc>
  13707. </method>
  13708. <method name="setCountersEnabled"
  13709. abstract="false" native="false" synchronized="false"
  13710. static="true" final="false" visibility="public"
  13711. deprecated="not deprecated">
  13712. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  13713. <param name="enabled" type="boolean"/>
  13714. <doc>
  13715. <![CDATA[Enables or disables counters for the named outputs.
  13716. <p/>
  13717. By default these counters are disabled.
  13718. <p/>
  13719. MultipleOutputs supports counters, by default the are disabled.
  13720. The counters group is the {@link MultipleOutputs} class name.
  13721. </p>
  13722. The names of the counters are the same as the named outputs. For multi
  13723. named outputs the name of the counter is the concatenation of the named
  13724. output, and underscore '_' and the multiname.
  13725. @param conf job conf to enableadd the named output.
  13726. @param enabled indicates if the counters will be enabled or not.]]>
  13727. </doc>
  13728. </method>
  13729. <method name="getCountersEnabled" return="boolean"
  13730. abstract="false" native="false" synchronized="false"
  13731. static="true" final="false" visibility="public"
  13732. deprecated="not deprecated">
  13733. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  13734. <doc>
  13735. <![CDATA[Returns if the counters for the named outputs are enabled or not.
  13736. <p/>
  13737. By default these counters are disabled.
  13738. <p/>
  13739. MultipleOutputs supports counters, by default the are disabled.
  13740. The counters group is the {@link MultipleOutputs} class name.
  13741. </p>
  13742. The names of the counters are the same as the named outputs. For multi
  13743. named outputs the name of the counter is the concatenation of the named
  13744. output, and underscore '_' and the multiname.
  13745. @param conf job conf to enableadd the named output.
  13746. @return TRUE if the counters are enabled, FALSE if they are disabled.]]>
  13747. </doc>
  13748. </method>
  13749. <method name="getNamedOutputs" return="java.util.Iterator"
  13750. abstract="false" native="false" synchronized="false"
  13751. static="false" final="false" visibility="public"
  13752. deprecated="not deprecated">
  13753. <doc>
  13754. <![CDATA[Returns iterator with the defined name outputs.
  13755. @return iterator with the defined named outputs]]>
  13756. </doc>
  13757. </method>
  13758. <method name="getCollector" return="org.apache.hadoop.mapred.OutputCollector"
  13759. abstract="false" native="false" synchronized="false"
  13760. static="false" final="false" visibility="public"
  13761. deprecated="not deprecated">
  13762. <param name="namedOutput" type="java.lang.String"/>
  13763. <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
  13764. <exception name="IOException" type="java.io.IOException"/>
  13765. <doc>
  13766. <![CDATA[Gets the output collector for a named output.
  13767. <p/>
  13768. @param namedOutput the named output name
  13769. @param reporter the reporter
  13770. @return the output collector for the given named output
  13771. @throws IOException thrown if output collector could not be created]]>
  13772. </doc>
  13773. </method>
  13774. <method name="getCollector" return="org.apache.hadoop.mapred.OutputCollector"
  13775. abstract="false" native="false" synchronized="false"
  13776. static="false" final="false" visibility="public"
  13777. deprecated="not deprecated">
  13778. <param name="namedOutput" type="java.lang.String"/>
  13779. <param name="multiName" type="java.lang.String"/>
  13780. <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
  13781. <exception name="IOException" type="java.io.IOException"/>
  13782. <doc>
  13783. <![CDATA[Gets the output collector for a multi named output.
  13784. <p/>
  13785. @param namedOutput the named output name
  13786. @param multiName the multi name part
  13787. @param reporter the reporter
  13788. @return the output collector for the given named output
  13789. @throws IOException thrown if output collector could not be created]]>
  13790. </doc>
  13791. </method>
  13792. <method name="close"
  13793. abstract="false" native="false" synchronized="false"
  13794. static="false" final="false" visibility="public"
  13795. deprecated="not deprecated">
  13796. <exception name="IOException" type="java.io.IOException"/>
  13797. <doc>
  13798. <![CDATA[Closes all the opened named outputs.
  13799. <p/>
  13800. If overriden subclasses must invoke <code>super.close()</code> at the
  13801. end of their <code>close()</code>
  13802. @throws java.io.IOException thrown if any of the MultipleOutput files
  13803. could not be closed properly.]]>
  13804. </doc>
  13805. </method>
  13806. <doc>
  13807. <![CDATA[The MultipleOutputs class simplifies writting to additional outputs other
  13808. than the job default output via the <code>OutputCollector</code> passed to
  13809. the <code>map()</code> and <code>reduce()</code> methods of the
  13810. <code>Mapper</code> and <code>Reducer</code> implementations.
  13811. <p/>
  13812. Each additional output, or named output, may be configured with its own
  13813. <code>OutputFormat</code>, with its own key class and with its own value
  13814. class.
  13815. <p/>
  13816. A named output can be a single file or a multi file. The later is refered as
  13817. a multi named output.
  13818. <p/>
  13819. A multi named output is an unbound set of files all sharing the same
  13820. <code>OutputFormat</code>, key class and value class configuration.
  13821. <p/>
  13822. When named outputs are used within a <code>Mapper</code> implementation,
  13823. key/values written to a name output are not part of the reduce phase, only
  13824. key/values written to the job <code>OutputCollector</code> are part of the
  13825. reduce phase.
  13826. <p/>
  13827. MultipleOutputs supports counters, by default the are disabled. The counters
  13828. group is the {@link MultipleOutputs} class name.
  13829. </p>
  13830. The names of the counters are the same as the named outputs. For multi
  13831. named outputs the name of the counter is the concatenation of the named
  13832. output, and underscore '_' and the multiname.
  13833. <p/>
  13834. Job configuration usage pattern is:
  13835. <pre>
  13836. JobConf conf = new JobConf();
  13837. conf.setInputPath(inDir);
  13838. FileOutputFormat.setOutputPath(conf, outDir);
  13839. conf.setMapperClass(MOMap.class);
  13840. conf.setReducerClass(MOReduce.class);
  13841. ...
  13842. // Defines additional single text based output 'text' for the job
  13843. MultipleOutputs.addNamedOutput(conf, "text", TextOutputFormat.class,
  13844. LongWritable.class, Text.class);
  13845. // Defines additional multi sequencefile based output 'sequence' for the
  13846. // job
  13847. MultipleOutputs.addMultiNamedOutput(conf, "seq",
  13848. SequenceFileOutputFormat.class,
  13849. LongWritable.class, Text.class);
  13850. ...
  13851. JobClient jc = new JobClient();
  13852. RunningJob job = jc.submitJob(conf);
  13853. ...
  13854. </pre>
  13855. <p/>
  13856. Job configuration usage pattern is:
  13857. <pre>
  13858. public class MOReduce implements
  13859. Reducer&lt;WritableComparable, Writable&gt; {
  13860. private MultipleOutputs mos;
  13861. public void configure(JobConf conf) {
  13862. ...
  13863. mos = new MultipleOutputs(conf);
  13864. }
  13865. public void reduce(WritableComparable key, Iterator&lt;Writable&gt; values,
  13866. OutputCollector output, Reporter reporter)
  13867. throws IOException {
  13868. ...
  13869. mos.getCollector("text", reporter).collect(key, new Text("Hello"));
  13870. mos.getCollector("seq", "A", reporter).collect(key, new Text("Bye"));
  13871. mos.getCollector("seq", "B", reporter).collect(key, new Text("Chau"));
  13872. ...
  13873. }
  13874. public void close() throws IOException {
  13875. mos.close();
  13876. ...
  13877. }
  13878. }
  13879. </pre>]]>
  13880. </doc>
  13881. </class>
  13882. <!-- end class org.apache.hadoop.mapred.lib.MultipleOutputs -->
  13883. <!-- start class org.apache.hadoop.mapred.lib.MultipleSequenceFileOutputFormat -->
  13884. <class name="MultipleSequenceFileOutputFormat" extends="org.apache.hadoop.mapred.lib.MultipleOutputFormat"
  13885. abstract="false"
  13886. static="false" final="false" visibility="public"
  13887. deprecated="not deprecated">
  13888. <constructor name="MultipleSequenceFileOutputFormat"
  13889. static="false" final="false" visibility="public"
  13890. deprecated="not deprecated">
  13891. </constructor>
  13892. <method name="getBaseRecordWriter" return="org.apache.hadoop.mapred.RecordWriter"
  13893. abstract="false" native="false" synchronized="false"
  13894. static="false" final="false" visibility="protected"
  13895. deprecated="not deprecated">
  13896. <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
  13897. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  13898. <param name="name" type="java.lang.String"/>
  13899. <param name="arg3" type="org.apache.hadoop.util.Progressable"/>
  13900. <exception name="IOException" type="java.io.IOException"/>
  13901. </method>
  13902. <doc>
  13903. <![CDATA[This class extends the MultipleOutputFormat, allowing to write the output data
  13904. to different output files in sequence file output format.]]>
  13905. </doc>
  13906. </class>
  13907. <!-- end class org.apache.hadoop.mapred.lib.MultipleSequenceFileOutputFormat -->
  13908. <!-- start class org.apache.hadoop.mapred.lib.MultipleTextOutputFormat -->
  13909. <class name="MultipleTextOutputFormat" extends="org.apache.hadoop.mapred.lib.MultipleOutputFormat"
  13910. abstract="false"
  13911. static="false" final="false" visibility="public"
  13912. deprecated="not deprecated">
  13913. <constructor name="MultipleTextOutputFormat"
  13914. static="false" final="false" visibility="public"
  13915. deprecated="not deprecated">
  13916. </constructor>
  13917. <method name="getBaseRecordWriter" return="org.apache.hadoop.mapred.RecordWriter"
  13918. abstract="false" native="false" synchronized="false"
  13919. static="false" final="false" visibility="protected"
  13920. deprecated="not deprecated">
  13921. <param name="fs" type="org.apache.hadoop.fs.FileSystem"/>
  13922. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  13923. <param name="name" type="java.lang.String"/>
  13924. <param name="arg3" type="org.apache.hadoop.util.Progressable"/>
  13925. <exception name="IOException" type="java.io.IOException"/>
  13926. </method>
  13927. <doc>
  13928. <![CDATA[This class extends the MultipleOutputFormat, allowing to write the output
  13929. data to different output files in Text output format.]]>
  13930. </doc>
  13931. </class>
  13932. <!-- end class org.apache.hadoop.mapred.lib.MultipleTextOutputFormat -->
  13933. <!-- start class org.apache.hadoop.mapred.lib.MultithreadedMapRunner -->
  13934. <class name="MultithreadedMapRunner" extends="java.lang.Object"
  13935. abstract="false"
  13936. static="false" final="false" visibility="public"
  13937. deprecated="not deprecated">
  13938. <implements name="org.apache.hadoop.mapred.MapRunnable"/>
  13939. <constructor name="MultithreadedMapRunner"
  13940. static="false" final="false" visibility="public"
  13941. deprecated="not deprecated">
  13942. </constructor>
  13943. <method name="configure"
  13944. abstract="false" native="false" synchronized="false"
  13945. static="false" final="false" visibility="public"
  13946. deprecated="not deprecated">
  13947. <param name="jobConf" type="org.apache.hadoop.mapred.JobConf"/>
  13948. </method>
  13949. <method name="run"
  13950. abstract="false" native="false" synchronized="false"
  13951. static="false" final="false" visibility="public"
  13952. deprecated="not deprecated">
  13953. <param name="input" type="org.apache.hadoop.mapred.RecordReader"/>
  13954. <param name="output" type="org.apache.hadoop.mapred.OutputCollector"/>
  13955. <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
  13956. <exception name="IOException" type="java.io.IOException"/>
  13957. </method>
  13958. <doc>
  13959. <![CDATA[Multithreaded implementation for @link org.apache.hadoop.mapred.MapRunnable.
  13960. <p>
  13961. It can be used instead of the default implementation,
  13962. @link org.apache.hadoop.mapred.MapRunner, when the Map operation is not CPU
  13963. bound in order to improve throughput.
  13964. <p>
  13965. Map implementations using this MapRunnable must be thread-safe.
  13966. <p>
  13967. The Map-Reduce job has to be configured to use this MapRunnable class (using
  13968. the JobConf.setMapRunnerClass method) and
  13969. the number of thread the thread-pool can use with the
  13970. <code>mapred.map.multithreadedrunner.threads</code> property, its default
  13971. value is 10 threads.
  13972. <p>]]>
  13973. </doc>
  13974. </class>
  13975. <!-- end class org.apache.hadoop.mapred.lib.MultithreadedMapRunner -->
  13976. <!-- start class org.apache.hadoop.mapred.lib.NLineInputFormat -->
  13977. <class name="NLineInputFormat" extends="org.apache.hadoop.mapred.FileInputFormat"
  13978. abstract="false"
  13979. static="false" final="false" visibility="public"
  13980. deprecated="not deprecated">
  13981. <implements name="org.apache.hadoop.mapred.JobConfigurable"/>
  13982. <constructor name="NLineInputFormat"
  13983. static="false" final="false" visibility="public"
  13984. deprecated="not deprecated">
  13985. </constructor>
  13986. <method name="getRecordReader" return="org.apache.hadoop.mapred.RecordReader"
  13987. abstract="false" native="false" synchronized="false"
  13988. static="false" final="false" visibility="public"
  13989. deprecated="not deprecated">
  13990. <param name="genericSplit" type="org.apache.hadoop.mapred.InputSplit"/>
  13991. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  13992. <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
  13993. <exception name="IOException" type="java.io.IOException"/>
  13994. </method>
  13995. <method name="getSplits" return="org.apache.hadoop.mapred.InputSplit[]"
  13996. abstract="false" native="false" synchronized="false"
  13997. static="false" final="false" visibility="public"
  13998. deprecated="not deprecated">
  13999. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  14000. <param name="numSplits" type="int"/>
  14001. <exception name="IOException" type="java.io.IOException"/>
  14002. <doc>
  14003. <![CDATA[Logically splits the set of input files for the job, splits N lines
  14004. of the input as one split.
  14005. @see org.apache.hadoop.mapred.FileInputFormat#getSplits(JobConf, int)]]>
  14006. </doc>
  14007. </method>
  14008. <method name="configure"
  14009. abstract="false" native="false" synchronized="false"
  14010. static="false" final="false" visibility="public"
  14011. deprecated="not deprecated">
  14012. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  14013. </method>
  14014. <doc>
  14015. <![CDATA[NLineInputFormat which splits N lines of input as one split.
  14016. In many "pleasantly" parallel applications, each process/mapper
  14017. processes the same input file (s), but with computations are
  14018. controlled by different parameters.(Referred to as "parameter sweeps").
  14019. One way to achieve this, is to specify a set of parameters
  14020. (one set per line) as input in a control file
  14021. (which is the input path to the map-reduce application,
  14022. where as the input dataset is specified
  14023. via a config variable in JobConf.).
  14024. The NLineInputFormat can be used in such applications, that splits
  14025. the input file such that by default, one line is fed as
  14026. a value to one map task, and key is the offset.
  14027. i.e. (k,v) is (LongWritable, Text).
  14028. The location hints will span the whole mapred cluster.]]>
  14029. </doc>
  14030. </class>
  14031. <!-- end class org.apache.hadoop.mapred.lib.NLineInputFormat -->
  14032. <!-- start class org.apache.hadoop.mapred.lib.NullOutputFormat -->
  14033. <class name="NullOutputFormat" extends="java.lang.Object"
  14034. abstract="false"
  14035. static="false" final="false" visibility="public"
  14036. deprecated="Use
  14037. {@link org.apache.hadoop.mapreduce.lib.output.NullOutputFormat} instead.">
  14038. <implements name="org.apache.hadoop.mapred.OutputFormat"/>
  14039. <constructor name="NullOutputFormat"
  14040. static="false" final="false" visibility="public"
  14041. deprecated="not deprecated">
  14042. </constructor>
  14043. <method name="getRecordWriter" return="org.apache.hadoop.mapred.RecordWriter"
  14044. abstract="false" native="false" synchronized="false"
  14045. static="false" final="false" visibility="public"
  14046. deprecated="not deprecated">
  14047. <param name="ignored" type="org.apache.hadoop.fs.FileSystem"/>
  14048. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  14049. <param name="name" type="java.lang.String"/>
  14050. <param name="progress" type="org.apache.hadoop.util.Progressable"/>
  14051. </method>
  14052. <method name="checkOutputSpecs"
  14053. abstract="false" native="false" synchronized="false"
  14054. static="false" final="false" visibility="public"
  14055. deprecated="not deprecated">
  14056. <param name="ignored" type="org.apache.hadoop.fs.FileSystem"/>
  14057. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  14058. </method>
  14059. <doc>
  14060. <![CDATA[Consume all outputs and put them in /dev/null.
  14061. @deprecated Use
  14062. {@link org.apache.hadoop.mapreduce.lib.output.NullOutputFormat} instead.]]>
  14063. </doc>
  14064. </class>
  14065. <!-- end class org.apache.hadoop.mapred.lib.NullOutputFormat -->
  14066. <!-- start class org.apache.hadoop.mapred.lib.RegexMapper -->
  14067. <class name="RegexMapper" extends="org.apache.hadoop.mapred.MapReduceBase"
  14068. abstract="false"
  14069. static="false" final="false" visibility="public"
  14070. deprecated="not deprecated">
  14071. <implements name="org.apache.hadoop.mapred.Mapper"/>
  14072. <constructor name="RegexMapper"
  14073. static="false" final="false" visibility="public"
  14074. deprecated="not deprecated">
  14075. </constructor>
  14076. <method name="configure"
  14077. abstract="false" native="false" synchronized="false"
  14078. static="false" final="false" visibility="public"
  14079. deprecated="not deprecated">
  14080. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  14081. </method>
  14082. <method name="map"
  14083. abstract="false" native="false" synchronized="false"
  14084. static="false" final="false" visibility="public"
  14085. deprecated="not deprecated">
  14086. <param name="key" type="java.lang.Object"/>
  14087. <param name="value" type="org.apache.hadoop.io.Text"/>
  14088. <param name="output" type="org.apache.hadoop.mapred.OutputCollector"/>
  14089. <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
  14090. <exception name="IOException" type="java.io.IOException"/>
  14091. </method>
  14092. <doc>
  14093. <![CDATA[A {@link Mapper} that extracts text matching a regular expression.]]>
  14094. </doc>
  14095. </class>
  14096. <!-- end class org.apache.hadoop.mapred.lib.RegexMapper -->
  14097. <!-- start class org.apache.hadoop.mapred.lib.TokenCountMapper -->
  14098. <class name="TokenCountMapper" extends="org.apache.hadoop.mapred.MapReduceBase"
  14099. abstract="false"
  14100. static="false" final="false" visibility="public"
  14101. deprecated="Use
  14102. {@link org.apache.hadoop.mapreduce.lib.map.TokenCounterMapper} instead.">
  14103. <implements name="org.apache.hadoop.mapred.Mapper"/>
  14104. <constructor name="TokenCountMapper"
  14105. static="false" final="false" visibility="public"
  14106. deprecated="not deprecated">
  14107. </constructor>
  14108. <method name="map"
  14109. abstract="false" native="false" synchronized="false"
  14110. static="false" final="false" visibility="public"
  14111. deprecated="not deprecated">
  14112. <param name="key" type="java.lang.Object"/>
  14113. <param name="value" type="org.apache.hadoop.io.Text"/>
  14114. <param name="output" type="org.apache.hadoop.mapred.OutputCollector"/>
  14115. <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
  14116. <exception name="IOException" type="java.io.IOException"/>
  14117. </method>
  14118. <doc>
  14119. <![CDATA[A {@link Mapper} that maps text values into <token,freq> pairs. Uses
  14120. {@link StringTokenizer} to break text into tokens.
  14121. @deprecated Use
  14122. {@link org.apache.hadoop.mapreduce.lib.map.TokenCounterMapper} instead.]]>
  14123. </doc>
  14124. </class>
  14125. <!-- end class org.apache.hadoop.mapred.lib.TokenCountMapper -->
  14126. <!-- start class org.apache.hadoop.mapred.lib.TotalOrderPartitioner -->
  14127. <class name="TotalOrderPartitioner" extends="java.lang.Object"
  14128. abstract="false"
  14129. static="false" final="false" visibility="public"
  14130. deprecated="not deprecated">
  14131. <implements name="org.apache.hadoop.mapred.Partitioner"/>
  14132. <constructor name="TotalOrderPartitioner"
  14133. static="false" final="false" visibility="public"
  14134. deprecated="not deprecated">
  14135. </constructor>
  14136. <method name="configure"
  14137. abstract="false" native="false" synchronized="false"
  14138. static="false" final="false" visibility="public"
  14139. deprecated="not deprecated">
  14140. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  14141. <doc>
  14142. <![CDATA[Read in the partition file and build indexing data structures.
  14143. If the keytype is {@link org.apache.hadoop.io.BinaryComparable} and
  14144. <tt>total.order.partitioner.natural.order</tt> is not false, a trie
  14145. of the first <tt>total.order.partitioner.max.trie.depth</tt>(2) + 1 bytes
  14146. will be built. Otherwise, keys will be located using a binary search of
  14147. the partition keyset using the {@link org.apache.hadoop.io.RawComparator}
  14148. defined for this job. The input file must be sorted with the same
  14149. comparator and contain {@link
  14150. org.apache.hadoop.mapred.JobConf#getNumReduceTasks} - 1 keys.]]>
  14151. </doc>
  14152. </method>
  14153. <method name="getPartition" return="int"
  14154. abstract="false" native="false" synchronized="false"
  14155. static="false" final="false" visibility="public"
  14156. deprecated="not deprecated">
  14157. <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
  14158. <param name="value" type="java.lang.Object"/>
  14159. <param name="numPartitions" type="int"/>
  14160. </method>
  14161. <method name="setPartitionFile"
  14162. abstract="false" native="false" synchronized="false"
  14163. static="true" final="false" visibility="public"
  14164. deprecated="not deprecated">
  14165. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  14166. <param name="p" type="org.apache.hadoop.fs.Path"/>
  14167. <doc>
  14168. <![CDATA[Set the path to the SequenceFile storing the sorted partition keyset.
  14169. It must be the case that for <tt>R</tt> reduces, there are <tt>R-1</tt>
  14170. keys in the SequenceFile.]]>
  14171. </doc>
  14172. </method>
  14173. <method name="getPartitionFile" return="java.lang.String"
  14174. abstract="false" native="false" synchronized="false"
  14175. static="true" final="false" visibility="public"
  14176. deprecated="not deprecated">
  14177. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  14178. <doc>
  14179. <![CDATA[Get the path to the SequenceFile storing the sorted partition keyset.
  14180. @see #setPartitionFile(JobConf,Path)]]>
  14181. </doc>
  14182. </method>
  14183. <field name="DEFAULT_PATH" type="java.lang.String"
  14184. transient="false" volatile="false"
  14185. static="true" final="true" visibility="public"
  14186. deprecated="not deprecated">
  14187. </field>
  14188. <doc>
  14189. <![CDATA[Partitioner effecting a total order by reading split points from
  14190. an externally generated source.]]>
  14191. </doc>
  14192. </class>
  14193. <!-- end class org.apache.hadoop.mapred.lib.TotalOrderPartitioner -->
  14194. </package>
  14195. <package name="org.apache.hadoop.mapred.lib.aggregate">
  14196. <!-- start class org.apache.hadoop.mapred.lib.aggregate.DoubleValueSum -->
  14197. <class name="DoubleValueSum" extends="java.lang.Object"
  14198. abstract="false"
  14199. static="false" final="false" visibility="public"
  14200. deprecated="not deprecated">
  14201. <implements name="org.apache.hadoop.mapred.lib.aggregate.ValueAggregator"/>
  14202. <constructor name="DoubleValueSum"
  14203. static="false" final="false" visibility="public"
  14204. deprecated="not deprecated">
  14205. <doc>
  14206. <![CDATA[The default constructor]]>
  14207. </doc>
  14208. </constructor>
  14209. <method name="addNextValue"
  14210. abstract="false" native="false" synchronized="false"
  14211. static="false" final="false" visibility="public"
  14212. deprecated="not deprecated">
  14213. <param name="val" type="java.lang.Object"/>
  14214. <doc>
  14215. <![CDATA[add a value to the aggregator
  14216. @param val
  14217. an object whose string representation represents a double value.]]>
  14218. </doc>
  14219. </method>
  14220. <method name="addNextValue"
  14221. abstract="false" native="false" synchronized="false"
  14222. static="false" final="false" visibility="public"
  14223. deprecated="not deprecated">
  14224. <param name="val" type="double"/>
  14225. <doc>
  14226. <![CDATA[add a value to the aggregator
  14227. @param val
  14228. a double value.]]>
  14229. </doc>
  14230. </method>
  14231. <method name="getReport" return="java.lang.String"
  14232. abstract="false" native="false" synchronized="false"
  14233. static="false" final="false" visibility="public"
  14234. deprecated="not deprecated">
  14235. <doc>
  14236. <![CDATA[@return the string representation of the aggregated value]]>
  14237. </doc>
  14238. </method>
  14239. <method name="getSum" return="double"
  14240. abstract="false" native="false" synchronized="false"
  14241. static="false" final="false" visibility="public"
  14242. deprecated="not deprecated">
  14243. <doc>
  14244. <![CDATA[@return the aggregated value]]>
  14245. </doc>
  14246. </method>
  14247. <method name="reset"
  14248. abstract="false" native="false" synchronized="false"
  14249. static="false" final="false" visibility="public"
  14250. deprecated="not deprecated">
  14251. <doc>
  14252. <![CDATA[reset the aggregator]]>
  14253. </doc>
  14254. </method>
  14255. <method name="getCombinerOutput" return="java.util.ArrayList"
  14256. abstract="false" native="false" synchronized="false"
  14257. static="false" final="false" visibility="public"
  14258. deprecated="not deprecated">
  14259. <doc>
  14260. <![CDATA[@return return an array of one element. The element is a string
  14261. representation of the aggregated value. The return value is
  14262. expected to be used by the a combiner.]]>
  14263. </doc>
  14264. </method>
  14265. <doc>
  14266. <![CDATA[This class implements a value aggregator that sums up a sequence of double
  14267. values.]]>
  14268. </doc>
  14269. </class>
  14270. <!-- end class org.apache.hadoop.mapred.lib.aggregate.DoubleValueSum -->
  14271. <!-- start class org.apache.hadoop.mapred.lib.aggregate.LongValueMax -->
  14272. <class name="LongValueMax" extends="java.lang.Object"
  14273. abstract="false"
  14274. static="false" final="false" visibility="public"
  14275. deprecated="not deprecated">
  14276. <implements name="org.apache.hadoop.mapred.lib.aggregate.ValueAggregator"/>
  14277. <constructor name="LongValueMax"
  14278. static="false" final="false" visibility="public"
  14279. deprecated="not deprecated">
  14280. <doc>
  14281. <![CDATA[the default constructor]]>
  14282. </doc>
  14283. </constructor>
  14284. <method name="addNextValue"
  14285. abstract="false" native="false" synchronized="false"
  14286. static="false" final="false" visibility="public"
  14287. deprecated="not deprecated">
  14288. <param name="val" type="java.lang.Object"/>
  14289. <doc>
  14290. <![CDATA[add a value to the aggregator
  14291. @param val
  14292. an object whose string representation represents a long value.]]>
  14293. </doc>
  14294. </method>
  14295. <method name="addNextValue"
  14296. abstract="false" native="false" synchronized="false"
  14297. static="false" final="false" visibility="public"
  14298. deprecated="not deprecated">
  14299. <param name="newVal" type="long"/>
  14300. <doc>
  14301. <![CDATA[add a value to the aggregator
  14302. @param newVal
  14303. a long value.]]>
  14304. </doc>
  14305. </method>
  14306. <method name="getVal" return="long"
  14307. abstract="false" native="false" synchronized="false"
  14308. static="false" final="false" visibility="public"
  14309. deprecated="not deprecated">
  14310. <doc>
  14311. <![CDATA[@return the aggregated value]]>
  14312. </doc>
  14313. </method>
  14314. <method name="getReport" return="java.lang.String"
  14315. abstract="false" native="false" synchronized="false"
  14316. static="false" final="false" visibility="public"
  14317. deprecated="not deprecated">
  14318. <doc>
  14319. <![CDATA[@return the string representation of the aggregated value]]>
  14320. </doc>
  14321. </method>
  14322. <method name="reset"
  14323. abstract="false" native="false" synchronized="false"
  14324. static="false" final="false" visibility="public"
  14325. deprecated="not deprecated">
  14326. <doc>
  14327. <![CDATA[reset the aggregator]]>
  14328. </doc>
  14329. </method>
  14330. <method name="getCombinerOutput" return="java.util.ArrayList"
  14331. abstract="false" native="false" synchronized="false"
  14332. static="false" final="false" visibility="public"
  14333. deprecated="not deprecated">
  14334. <doc>
  14335. <![CDATA[@return return an array of one element. The element is a string
  14336. representation of the aggregated value. The return value is
  14337. expected to be used by the a combiner.]]>
  14338. </doc>
  14339. </method>
  14340. <doc>
  14341. <![CDATA[This class implements a value aggregator that maintain the maximum of
  14342. a sequence of long values.]]>
  14343. </doc>
  14344. </class>
  14345. <!-- end class org.apache.hadoop.mapred.lib.aggregate.LongValueMax -->
  14346. <!-- start class org.apache.hadoop.mapred.lib.aggregate.LongValueMin -->
  14347. <class name="LongValueMin" extends="java.lang.Object"
  14348. abstract="false"
  14349. static="false" final="false" visibility="public"
  14350. deprecated="not deprecated">
  14351. <implements name="org.apache.hadoop.mapred.lib.aggregate.ValueAggregator"/>
  14352. <constructor name="LongValueMin"
  14353. static="false" final="false" visibility="public"
  14354. deprecated="not deprecated">
  14355. <doc>
  14356. <![CDATA[the default constructor]]>
  14357. </doc>
  14358. </constructor>
  14359. <method name="addNextValue"
  14360. abstract="false" native="false" synchronized="false"
  14361. static="false" final="false" visibility="public"
  14362. deprecated="not deprecated">
  14363. <param name="val" type="java.lang.Object"/>
  14364. <doc>
  14365. <![CDATA[add a value to the aggregator
  14366. @param val
  14367. an object whose string representation represents a long value.]]>
  14368. </doc>
  14369. </method>
  14370. <method name="addNextValue"
  14371. abstract="false" native="false" synchronized="false"
  14372. static="false" final="false" visibility="public"
  14373. deprecated="not deprecated">
  14374. <param name="newVal" type="long"/>
  14375. <doc>
  14376. <![CDATA[add a value to the aggregator
  14377. @param newVal
  14378. a long value.]]>
  14379. </doc>
  14380. </method>
  14381. <method name="getVal" return="long"
  14382. abstract="false" native="false" synchronized="false"
  14383. static="false" final="false" visibility="public"
  14384. deprecated="not deprecated">
  14385. <doc>
  14386. <![CDATA[@return the aggregated value]]>
  14387. </doc>
  14388. </method>
  14389. <method name="getReport" return="java.lang.String"
  14390. abstract="false" native="false" synchronized="false"
  14391. static="false" final="false" visibility="public"
  14392. deprecated="not deprecated">
  14393. <doc>
  14394. <![CDATA[@return the string representation of the aggregated value]]>
  14395. </doc>
  14396. </method>
  14397. <method name="reset"
  14398. abstract="false" native="false" synchronized="false"
  14399. static="false" final="false" visibility="public"
  14400. deprecated="not deprecated">
  14401. <doc>
  14402. <![CDATA[reset the aggregator]]>
  14403. </doc>
  14404. </method>
  14405. <method name="getCombinerOutput" return="java.util.ArrayList"
  14406. abstract="false" native="false" synchronized="false"
  14407. static="false" final="false" visibility="public"
  14408. deprecated="not deprecated">
  14409. <doc>
  14410. <![CDATA[@return return an array of one element. The element is a string
  14411. representation of the aggregated value. The return value is
  14412. expected to be used by the a combiner.]]>
  14413. </doc>
  14414. </method>
  14415. <doc>
  14416. <![CDATA[This class implements a value aggregator that maintain the minimum of
  14417. a sequence of long values.]]>
  14418. </doc>
  14419. </class>
  14420. <!-- end class org.apache.hadoop.mapred.lib.aggregate.LongValueMin -->
  14421. <!-- start class org.apache.hadoop.mapred.lib.aggregate.LongValueSum -->
  14422. <class name="LongValueSum" extends="java.lang.Object"
  14423. abstract="false"
  14424. static="false" final="false" visibility="public"
  14425. deprecated="not deprecated">
  14426. <implements name="org.apache.hadoop.mapred.lib.aggregate.ValueAggregator"/>
  14427. <constructor name="LongValueSum"
  14428. static="false" final="false" visibility="public"
  14429. deprecated="not deprecated">
  14430. <doc>
  14431. <![CDATA[the default constructor]]>
  14432. </doc>
  14433. </constructor>
  14434. <method name="addNextValue"
  14435. abstract="false" native="false" synchronized="false"
  14436. static="false" final="false" visibility="public"
  14437. deprecated="not deprecated">
  14438. <param name="val" type="java.lang.Object"/>
  14439. <doc>
  14440. <![CDATA[add a value to the aggregator
  14441. @param val
  14442. an object whose string representation represents a long value.]]>
  14443. </doc>
  14444. </method>
  14445. <method name="addNextValue"
  14446. abstract="false" native="false" synchronized="false"
  14447. static="false" final="false" visibility="public"
  14448. deprecated="not deprecated">
  14449. <param name="val" type="long"/>
  14450. <doc>
  14451. <![CDATA[add a value to the aggregator
  14452. @param val
  14453. a long value.]]>
  14454. </doc>
  14455. </method>
  14456. <method name="getSum" return="long"
  14457. abstract="false" native="false" synchronized="false"
  14458. static="false" final="false" visibility="public"
  14459. deprecated="not deprecated">
  14460. <doc>
  14461. <![CDATA[@return the aggregated value]]>
  14462. </doc>
  14463. </method>
  14464. <method name="getReport" return="java.lang.String"
  14465. abstract="false" native="false" synchronized="false"
  14466. static="false" final="false" visibility="public"
  14467. deprecated="not deprecated">
  14468. <doc>
  14469. <![CDATA[@return the string representation of the aggregated value]]>
  14470. </doc>
  14471. </method>
  14472. <method name="reset"
  14473. abstract="false" native="false" synchronized="false"
  14474. static="false" final="false" visibility="public"
  14475. deprecated="not deprecated">
  14476. <doc>
  14477. <![CDATA[reset the aggregator]]>
  14478. </doc>
  14479. </method>
  14480. <method name="getCombinerOutput" return="java.util.ArrayList"
  14481. abstract="false" native="false" synchronized="false"
  14482. static="false" final="false" visibility="public"
  14483. deprecated="not deprecated">
  14484. <doc>
  14485. <![CDATA[@return return an array of one element. The element is a string
  14486. representation of the aggregated value. The return value is
  14487. expected to be used by the a combiner.]]>
  14488. </doc>
  14489. </method>
  14490. <doc>
  14491. <![CDATA[This class implements a value aggregator that sums up
  14492. a sequence of long values.]]>
  14493. </doc>
  14494. </class>
  14495. <!-- end class org.apache.hadoop.mapred.lib.aggregate.LongValueSum -->
  14496. <!-- start class org.apache.hadoop.mapred.lib.aggregate.StringValueMax -->
  14497. <class name="StringValueMax" extends="java.lang.Object"
  14498. abstract="false"
  14499. static="false" final="false" visibility="public"
  14500. deprecated="not deprecated">
  14501. <implements name="org.apache.hadoop.mapred.lib.aggregate.ValueAggregator"/>
  14502. <constructor name="StringValueMax"
  14503. static="false" final="false" visibility="public"
  14504. deprecated="not deprecated">
  14505. <doc>
  14506. <![CDATA[the default constructor]]>
  14507. </doc>
  14508. </constructor>
  14509. <method name="addNextValue"
  14510. abstract="false" native="false" synchronized="false"
  14511. static="false" final="false" visibility="public"
  14512. deprecated="not deprecated">
  14513. <param name="val" type="java.lang.Object"/>
  14514. <doc>
  14515. <![CDATA[add a value to the aggregator
  14516. @param val
  14517. a string.]]>
  14518. </doc>
  14519. </method>
  14520. <method name="getVal" return="java.lang.String"
  14521. abstract="false" native="false" synchronized="false"
  14522. static="false" final="false" visibility="public"
  14523. deprecated="not deprecated">
  14524. <doc>
  14525. <![CDATA[@return the aggregated value]]>
  14526. </doc>
  14527. </method>
  14528. <method name="getReport" return="java.lang.String"
  14529. abstract="false" native="false" synchronized="false"
  14530. static="false" final="false" visibility="public"
  14531. deprecated="not deprecated">
  14532. <doc>
  14533. <![CDATA[@return the string representation of the aggregated value]]>
  14534. </doc>
  14535. </method>
  14536. <method name="reset"
  14537. abstract="false" native="false" synchronized="false"
  14538. static="false" final="false" visibility="public"
  14539. deprecated="not deprecated">
  14540. <doc>
  14541. <![CDATA[reset the aggregator]]>
  14542. </doc>
  14543. </method>
  14544. <method name="getCombinerOutput" return="java.util.ArrayList"
  14545. abstract="false" native="false" synchronized="false"
  14546. static="false" final="false" visibility="public"
  14547. deprecated="not deprecated">
  14548. <doc>
  14549. <![CDATA[@return return an array of one element. The element is a string
  14550. representation of the aggregated value. The return value is
  14551. expected to be used by the a combiner.]]>
  14552. </doc>
  14553. </method>
  14554. <doc>
  14555. <![CDATA[This class implements a value aggregator that maintain the biggest of
  14556. a sequence of strings.]]>
  14557. </doc>
  14558. </class>
  14559. <!-- end class org.apache.hadoop.mapred.lib.aggregate.StringValueMax -->
  14560. <!-- start class org.apache.hadoop.mapred.lib.aggregate.StringValueMin -->
  14561. <class name="StringValueMin" extends="java.lang.Object"
  14562. abstract="false"
  14563. static="false" final="false" visibility="public"
  14564. deprecated="not deprecated">
  14565. <implements name="org.apache.hadoop.mapred.lib.aggregate.ValueAggregator"/>
  14566. <constructor name="StringValueMin"
  14567. static="false" final="false" visibility="public"
  14568. deprecated="not deprecated">
  14569. <doc>
  14570. <![CDATA[the default constructor]]>
  14571. </doc>
  14572. </constructor>
  14573. <method name="addNextValue"
  14574. abstract="false" native="false" synchronized="false"
  14575. static="false" final="false" visibility="public"
  14576. deprecated="not deprecated">
  14577. <param name="val" type="java.lang.Object"/>
  14578. <doc>
  14579. <![CDATA[add a value to the aggregator
  14580. @param val
  14581. a string.]]>
  14582. </doc>
  14583. </method>
  14584. <method name="getVal" return="java.lang.String"
  14585. abstract="false" native="false" synchronized="false"
  14586. static="false" final="false" visibility="public"
  14587. deprecated="not deprecated">
  14588. <doc>
  14589. <![CDATA[@return the aggregated value]]>
  14590. </doc>
  14591. </method>
  14592. <method name="getReport" return="java.lang.String"
  14593. abstract="false" native="false" synchronized="false"
  14594. static="false" final="false" visibility="public"
  14595. deprecated="not deprecated">
  14596. <doc>
  14597. <![CDATA[@return the string representation of the aggregated value]]>
  14598. </doc>
  14599. </method>
  14600. <method name="reset"
  14601. abstract="false" native="false" synchronized="false"
  14602. static="false" final="false" visibility="public"
  14603. deprecated="not deprecated">
  14604. <doc>
  14605. <![CDATA[reset the aggregator]]>
  14606. </doc>
  14607. </method>
  14608. <method name="getCombinerOutput" return="java.util.ArrayList"
  14609. abstract="false" native="false" synchronized="false"
  14610. static="false" final="false" visibility="public"
  14611. deprecated="not deprecated">
  14612. <doc>
  14613. <![CDATA[@return return an array of one element. The element is a string
  14614. representation of the aggregated value. The return value is
  14615. expected to be used by the a combiner.]]>
  14616. </doc>
  14617. </method>
  14618. <doc>
  14619. <![CDATA[This class implements a value aggregator that maintain the smallest of
  14620. a sequence of strings.]]>
  14621. </doc>
  14622. </class>
  14623. <!-- end class org.apache.hadoop.mapred.lib.aggregate.StringValueMin -->
  14624. <!-- start class org.apache.hadoop.mapred.lib.aggregate.UniqValueCount -->
  14625. <class name="UniqValueCount" extends="java.lang.Object"
  14626. abstract="false"
  14627. static="false" final="false" visibility="public"
  14628. deprecated="not deprecated">
  14629. <implements name="org.apache.hadoop.mapred.lib.aggregate.ValueAggregator"/>
  14630. <constructor name="UniqValueCount"
  14631. static="false" final="false" visibility="public"
  14632. deprecated="not deprecated">
  14633. <doc>
  14634. <![CDATA[the default constructor]]>
  14635. </doc>
  14636. </constructor>
  14637. <constructor name="UniqValueCount" type="long"
  14638. static="false" final="false" visibility="public"
  14639. deprecated="not deprecated">
  14640. <doc>
  14641. <![CDATA[constructor
  14642. @param maxNum the limit in the number of unique values to keep.]]>
  14643. </doc>
  14644. </constructor>
  14645. <method name="setMaxItems" return="long"
  14646. abstract="false" native="false" synchronized="false"
  14647. static="false" final="false" visibility="public"
  14648. deprecated="not deprecated">
  14649. <param name="n" type="long"/>
  14650. <doc>
  14651. <![CDATA[Set the limit on the number of unique values
  14652. @param n the desired limit on the number of unique values
  14653. @return the new limit on the number of unique values]]>
  14654. </doc>
  14655. </method>
  14656. <method name="addNextValue"
  14657. abstract="false" native="false" synchronized="false"
  14658. static="false" final="false" visibility="public"
  14659. deprecated="not deprecated">
  14660. <param name="val" type="java.lang.Object"/>
  14661. <doc>
  14662. <![CDATA[add a value to the aggregator
  14663. @param val
  14664. an object.]]>
  14665. </doc>
  14666. </method>
  14667. <method name="getReport" return="java.lang.String"
  14668. abstract="false" native="false" synchronized="false"
  14669. static="false" final="false" visibility="public"
  14670. deprecated="not deprecated">
  14671. <doc>
  14672. <![CDATA[@return return the number of unique objects aggregated]]>
  14673. </doc>
  14674. </method>
  14675. <method name="getUniqueItems" return="java.util.Set"
  14676. abstract="false" native="false" synchronized="false"
  14677. static="false" final="false" visibility="public"
  14678. deprecated="not deprecated">
  14679. <doc>
  14680. <![CDATA[@return the set of the unique objects]]>
  14681. </doc>
  14682. </method>
  14683. <method name="reset"
  14684. abstract="false" native="false" synchronized="false"
  14685. static="false" final="false" visibility="public"
  14686. deprecated="not deprecated">
  14687. <doc>
  14688. <![CDATA[reset the aggregator]]>
  14689. </doc>
  14690. </method>
  14691. <method name="getCombinerOutput" return="java.util.ArrayList"
  14692. abstract="false" native="false" synchronized="false"
  14693. static="false" final="false" visibility="public"
  14694. deprecated="not deprecated">
  14695. <doc>
  14696. <![CDATA[@return return an array of the unique objects. The return value is
  14697. expected to be used by the a combiner.]]>
  14698. </doc>
  14699. </method>
  14700. <doc>
  14701. <![CDATA[This class implements a value aggregator that dedupes a sequence of objects.]]>
  14702. </doc>
  14703. </class>
  14704. <!-- end class org.apache.hadoop.mapred.lib.aggregate.UniqValueCount -->
  14705. <!-- start class org.apache.hadoop.mapred.lib.aggregate.UserDefinedValueAggregatorDescriptor -->
  14706. <class name="UserDefinedValueAggregatorDescriptor" extends="java.lang.Object"
  14707. abstract="false"
  14708. static="false" final="false" visibility="public"
  14709. deprecated="not deprecated">
  14710. <implements name="org.apache.hadoop.mapred.lib.aggregate.ValueAggregatorDescriptor"/>
  14711. <constructor name="UserDefinedValueAggregatorDescriptor" type="java.lang.String, org.apache.hadoop.mapred.JobConf"
  14712. static="false" final="false" visibility="public"
  14713. deprecated="not deprecated">
  14714. <doc>
  14715. <![CDATA[@param className the class name of the user defined descriptor class
  14716. @param job a configure object used for decriptor configuration]]>
  14717. </doc>
  14718. </constructor>
  14719. <method name="createInstance" return="java.lang.Object"
  14720. abstract="false" native="false" synchronized="false"
  14721. static="true" final="false" visibility="public"
  14722. deprecated="not deprecated">
  14723. <param name="className" type="java.lang.String"/>
  14724. <doc>
  14725. <![CDATA[Create an instance of the given class
  14726. @param className the name of the class
  14727. @return a dynamically created instance of the given class]]>
  14728. </doc>
  14729. </method>
  14730. <method name="generateKeyValPairs" return="java.util.ArrayList"
  14731. abstract="false" native="false" synchronized="false"
  14732. static="false" final="false" visibility="public"
  14733. deprecated="not deprecated">
  14734. <param name="key" type="java.lang.Object"/>
  14735. <param name="val" type="java.lang.Object"/>
  14736. <doc>
  14737. <![CDATA[Generate a list of aggregation-id/value pairs for the given key/value pairs
  14738. by delegating the invocation to the real object.
  14739. @param key
  14740. input key
  14741. @param val
  14742. input value
  14743. @return a list of aggregation id/value pairs. An aggregation id encodes an
  14744. aggregation type which is used to guide the way to aggregate the
  14745. value in the reduce/combiner phrase of an Aggregate based job.]]>
  14746. </doc>
  14747. </method>
  14748. <method name="toString" return="java.lang.String"
  14749. abstract="false" native="false" synchronized="false"
  14750. static="false" final="false" visibility="public"
  14751. deprecated="not deprecated">
  14752. <doc>
  14753. <![CDATA[@return the string representation of this object.]]>
  14754. </doc>
  14755. </method>
  14756. <method name="configure"
  14757. abstract="false" native="false" synchronized="false"
  14758. static="false" final="false" visibility="public"
  14759. deprecated="not deprecated">
  14760. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  14761. <doc>
  14762. <![CDATA[Do nothing.]]>
  14763. </doc>
  14764. </method>
  14765. <doc>
  14766. <![CDATA[This class implements a wrapper for a user defined value aggregator descriptor.
  14767. It servs two functions: One is to create an object of ValueAggregatorDescriptor from the
  14768. name of a user defined class that may be dynamically loaded. The other is to
  14769. deligate inviokations of generateKeyValPairs function to the created object.]]>
  14770. </doc>
  14771. </class>
  14772. <!-- end class org.apache.hadoop.mapred.lib.aggregate.UserDefinedValueAggregatorDescriptor -->
  14773. <!-- start interface org.apache.hadoop.mapred.lib.aggregate.ValueAggregator -->
  14774. <interface name="ValueAggregator" abstract="true"
  14775. static="false" final="false" visibility="public"
  14776. deprecated="not deprecated">
  14777. <method name="addNextValue"
  14778. abstract="false" native="false" synchronized="false"
  14779. static="false" final="false" visibility="public"
  14780. deprecated="not deprecated">
  14781. <param name="val" type="java.lang.Object"/>
  14782. <doc>
  14783. <![CDATA[add a value to the aggregator
  14784. @param val the value to be added]]>
  14785. </doc>
  14786. </method>
  14787. <method name="reset"
  14788. abstract="false" native="false" synchronized="false"
  14789. static="false" final="false" visibility="public"
  14790. deprecated="not deprecated">
  14791. <doc>
  14792. <![CDATA[reset the aggregator]]>
  14793. </doc>
  14794. </method>
  14795. <method name="getReport" return="java.lang.String"
  14796. abstract="false" native="false" synchronized="false"
  14797. static="false" final="false" visibility="public"
  14798. deprecated="not deprecated">
  14799. <doc>
  14800. <![CDATA[@return the string representation of the agregator]]>
  14801. </doc>
  14802. </method>
  14803. <method name="getCombinerOutput" return="java.util.ArrayList"
  14804. abstract="false" native="false" synchronized="false"
  14805. static="false" final="false" visibility="public"
  14806. deprecated="not deprecated">
  14807. <doc>
  14808. <![CDATA[@return an array of values as the outputs of the combiner.]]>
  14809. </doc>
  14810. </method>
  14811. <doc>
  14812. <![CDATA[This interface defines the minimal protocol for value aggregators.]]>
  14813. </doc>
  14814. </interface>
  14815. <!-- end interface org.apache.hadoop.mapred.lib.aggregate.ValueAggregator -->
  14816. <!-- start class org.apache.hadoop.mapred.lib.aggregate.ValueAggregatorBaseDescriptor -->
  14817. <class name="ValueAggregatorBaseDescriptor" extends="java.lang.Object"
  14818. abstract="false"
  14819. static="false" final="false" visibility="public"
  14820. deprecated="not deprecated">
  14821. <implements name="org.apache.hadoop.mapred.lib.aggregate.ValueAggregatorDescriptor"/>
  14822. <constructor name="ValueAggregatorBaseDescriptor"
  14823. static="false" final="false" visibility="public"
  14824. deprecated="not deprecated">
  14825. </constructor>
  14826. <method name="generateEntry" return="java.util.Map.Entry"
  14827. abstract="false" native="false" synchronized="false"
  14828. static="true" final="false" visibility="public"
  14829. deprecated="not deprecated">
  14830. <param name="type" type="java.lang.String"/>
  14831. <param name="id" type="java.lang.String"/>
  14832. <param name="val" type="org.apache.hadoop.io.Text"/>
  14833. <doc>
  14834. <![CDATA[@param type the aggregation type
  14835. @param id the aggregation id
  14836. @param val the val associated with the id to be aggregated
  14837. @return an Entry whose key is the aggregation id prefixed with
  14838. the aggregation type.]]>
  14839. </doc>
  14840. </method>
  14841. <method name="generateValueAggregator" return="org.apache.hadoop.mapred.lib.aggregate.ValueAggregator"
  14842. abstract="false" native="false" synchronized="false"
  14843. static="true" final="false" visibility="public"
  14844. deprecated="not deprecated">
  14845. <param name="type" type="java.lang.String"/>
  14846. <doc>
  14847. <![CDATA[@param type the aggregation type
  14848. @return a value aggregator of the given type.]]>
  14849. </doc>
  14850. </method>
  14851. <method name="generateKeyValPairs" return="java.util.ArrayList"
  14852. abstract="false" native="false" synchronized="false"
  14853. static="false" final="false" visibility="public"
  14854. deprecated="not deprecated">
  14855. <param name="key" type="java.lang.Object"/>
  14856. <param name="val" type="java.lang.Object"/>
  14857. <doc>
  14858. <![CDATA[Generate 1 or 2 aggregation-id/value pairs for the given key/value pair.
  14859. The first id will be of type LONG_VALUE_SUM, with "record_count" as
  14860. its aggregation id. If the input is a file split,
  14861. the second id of the same type will be generated too, with the file name
  14862. as its aggregation id. This achieves the behavior of counting the total number
  14863. of records in the input data, and the number of records in each input file.
  14864. @param key
  14865. input key
  14866. @param val
  14867. input value
  14868. @return a list of aggregation id/value pairs. An aggregation id encodes an
  14869. aggregation type which is used to guide the way to aggregate the
  14870. value in the reduce/combiner phrase of an Aggregate based job.]]>
  14871. </doc>
  14872. </method>
  14873. <method name="configure"
  14874. abstract="false" native="false" synchronized="false"
  14875. static="false" final="false" visibility="public"
  14876. deprecated="not deprecated">
  14877. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  14878. <doc>
  14879. <![CDATA[get the input file name.
  14880. @param job a job configuration object]]>
  14881. </doc>
  14882. </method>
  14883. <field name="UNIQ_VALUE_COUNT" type="java.lang.String"
  14884. transient="false" volatile="false"
  14885. static="true" final="true" visibility="public"
  14886. deprecated="not deprecated">
  14887. </field>
  14888. <field name="LONG_VALUE_SUM" type="java.lang.String"
  14889. transient="false" volatile="false"
  14890. static="true" final="true" visibility="public"
  14891. deprecated="not deprecated">
  14892. </field>
  14893. <field name="DOUBLE_VALUE_SUM" type="java.lang.String"
  14894. transient="false" volatile="false"
  14895. static="true" final="true" visibility="public"
  14896. deprecated="not deprecated">
  14897. </field>
  14898. <field name="VALUE_HISTOGRAM" type="java.lang.String"
  14899. transient="false" volatile="false"
  14900. static="true" final="true" visibility="public"
  14901. deprecated="not deprecated">
  14902. </field>
  14903. <field name="LONG_VALUE_MAX" type="java.lang.String"
  14904. transient="false" volatile="false"
  14905. static="true" final="true" visibility="public"
  14906. deprecated="not deprecated">
  14907. </field>
  14908. <field name="LONG_VALUE_MIN" type="java.lang.String"
  14909. transient="false" volatile="false"
  14910. static="true" final="true" visibility="public"
  14911. deprecated="not deprecated">
  14912. </field>
  14913. <field name="STRING_VALUE_MAX" type="java.lang.String"
  14914. transient="false" volatile="false"
  14915. static="true" final="true" visibility="public"
  14916. deprecated="not deprecated">
  14917. </field>
  14918. <field name="STRING_VALUE_MIN" type="java.lang.String"
  14919. transient="false" volatile="false"
  14920. static="true" final="true" visibility="public"
  14921. deprecated="not deprecated">
  14922. </field>
  14923. <field name="inputFile" type="java.lang.String"
  14924. transient="false" volatile="false"
  14925. static="false" final="false" visibility="public"
  14926. deprecated="not deprecated">
  14927. </field>
  14928. <doc>
  14929. <![CDATA[This class implements the common functionalities of
  14930. the subclasses of ValueAggregatorDescriptor class.]]>
  14931. </doc>
  14932. </class>
  14933. <!-- end class org.apache.hadoop.mapred.lib.aggregate.ValueAggregatorBaseDescriptor -->
  14934. <!-- start class org.apache.hadoop.mapred.lib.aggregate.ValueAggregatorCombiner -->
  14935. <class name="ValueAggregatorCombiner" extends="org.apache.hadoop.mapred.lib.aggregate.ValueAggregatorJobBase"
  14936. abstract="false"
  14937. static="false" final="false" visibility="public"
  14938. deprecated="not deprecated">
  14939. <constructor name="ValueAggregatorCombiner"
  14940. static="false" final="false" visibility="public"
  14941. deprecated="not deprecated">
  14942. </constructor>
  14943. <method name="configure"
  14944. abstract="false" native="false" synchronized="false"
  14945. static="false" final="false" visibility="public"
  14946. deprecated="not deprecated">
  14947. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  14948. <doc>
  14949. <![CDATA[Combiner does not need to configure.]]>
  14950. </doc>
  14951. </method>
  14952. <method name="reduce"
  14953. abstract="false" native="false" synchronized="false"
  14954. static="false" final="false" visibility="public"
  14955. deprecated="not deprecated">
  14956. <param name="key" type="org.apache.hadoop.io.Text"/>
  14957. <param name="values" type="java.util.Iterator"/>
  14958. <param name="output" type="org.apache.hadoop.mapred.OutputCollector"/>
  14959. <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
  14960. <exception name="IOException" type="java.io.IOException"/>
  14961. <doc>
  14962. <![CDATA[Combines values for a given key.
  14963. @param key the key is expected to be a Text object, whose prefix indicates
  14964. the type of aggregation to aggregate the values.
  14965. @param values the values to combine
  14966. @param output to collect combined values]]>
  14967. </doc>
  14968. </method>
  14969. <method name="close"
  14970. abstract="false" native="false" synchronized="false"
  14971. static="false" final="false" visibility="public"
  14972. deprecated="not deprecated">
  14973. <exception name="IOException" type="java.io.IOException"/>
  14974. <doc>
  14975. <![CDATA[Do nothing.]]>
  14976. </doc>
  14977. </method>
  14978. <method name="map"
  14979. abstract="false" native="false" synchronized="false"
  14980. static="false" final="false" visibility="public"
  14981. deprecated="not deprecated">
  14982. <param name="arg0" type="org.apache.hadoop.io.WritableComparable"/>
  14983. <param name="arg1" type="org.apache.hadoop.io.Writable"/>
  14984. <param name="arg2" type="org.apache.hadoop.mapred.OutputCollector"/>
  14985. <param name="arg3" type="org.apache.hadoop.mapred.Reporter"/>
  14986. <exception name="IOException" type="java.io.IOException"/>
  14987. <doc>
  14988. <![CDATA[Do nothing. Should not be called.]]>
  14989. </doc>
  14990. </method>
  14991. <doc>
  14992. <![CDATA[This class implements the generic combiner of Aggregate.]]>
  14993. </doc>
  14994. </class>
  14995. <!-- end class org.apache.hadoop.mapred.lib.aggregate.ValueAggregatorCombiner -->
  14996. <!-- start interface org.apache.hadoop.mapred.lib.aggregate.ValueAggregatorDescriptor -->
  14997. <interface name="ValueAggregatorDescriptor" abstract="true"
  14998. static="false" final="false" visibility="public"
  14999. deprecated="not deprecated">
  15000. <method name="generateKeyValPairs" return="java.util.ArrayList"
  15001. abstract="false" native="false" synchronized="false"
  15002. static="false" final="false" visibility="public"
  15003. deprecated="not deprecated">
  15004. <param name="key" type="java.lang.Object"/>
  15005. <param name="val" type="java.lang.Object"/>
  15006. <doc>
  15007. <![CDATA[Generate a list of aggregation-id/value pairs for the given key/value pair.
  15008. This function is usually called by the mapper of an Aggregate based job.
  15009. @param key
  15010. input key
  15011. @param val
  15012. input value
  15013. @return a list of aggregation id/value pairs. An aggregation id encodes an
  15014. aggregation type which is used to guide the way to aggregate the
  15015. value in the reduce/combiner phrase of an Aggregate based job.]]>
  15016. </doc>
  15017. </method>
  15018. <method name="configure"
  15019. abstract="false" native="false" synchronized="false"
  15020. static="false" final="false" visibility="public"
  15021. deprecated="not deprecated">
  15022. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  15023. <doc>
  15024. <![CDATA[Configure the object
  15025. @param job
  15026. a JobConf object that may contain the information that can be used
  15027. to configure the object.]]>
  15028. </doc>
  15029. </method>
  15030. <field name="TYPE_SEPARATOR" type="java.lang.String"
  15031. transient="false" volatile="false"
  15032. static="true" final="true" visibility="public"
  15033. deprecated="not deprecated">
  15034. </field>
  15035. <field name="ONE" type="org.apache.hadoop.io.Text"
  15036. transient="false" volatile="false"
  15037. static="true" final="true" visibility="public"
  15038. deprecated="not deprecated">
  15039. </field>
  15040. <doc>
  15041. <![CDATA[This interface defines the contract a value aggregator descriptor must
  15042. support. Such a descriptor can be configured with a JobConf object. Its main
  15043. function is to generate a list of aggregation-id/value pairs. An aggregation
  15044. id encodes an aggregation type which is used to guide the way to aggregate
  15045. the value in the reduce/combiner phrase of an Aggregate based job.The mapper in
  15046. an Aggregate based map/reduce job may create one or more of
  15047. ValueAggregatorDescriptor objects at configuration time. For each input
  15048. key/value pair, the mapper will use those objects to create aggregation
  15049. id/value pairs.]]>
  15050. </doc>
  15051. </interface>
  15052. <!-- end interface org.apache.hadoop.mapred.lib.aggregate.ValueAggregatorDescriptor -->
  15053. <!-- start class org.apache.hadoop.mapred.lib.aggregate.ValueAggregatorJob -->
  15054. <class name="ValueAggregatorJob" extends="java.lang.Object"
  15055. abstract="false"
  15056. static="false" final="false" visibility="public"
  15057. deprecated="not deprecated">
  15058. <constructor name="ValueAggregatorJob"
  15059. static="false" final="false" visibility="public"
  15060. deprecated="not deprecated">
  15061. </constructor>
  15062. <method name="createValueAggregatorJobs" return="org.apache.hadoop.mapred.jobcontrol.JobControl"
  15063. abstract="false" native="false" synchronized="false"
  15064. static="true" final="false" visibility="public"
  15065. deprecated="not deprecated">
  15066. <param name="args" type="java.lang.String[]"/>
  15067. <param name="descriptors" type="java.lang.Class[]"/>
  15068. <exception name="IOException" type="java.io.IOException"/>
  15069. </method>
  15070. <method name="createValueAggregatorJobs" return="org.apache.hadoop.mapred.jobcontrol.JobControl"
  15071. abstract="false" native="false" synchronized="false"
  15072. static="true" final="false" visibility="public"
  15073. deprecated="not deprecated">
  15074. <param name="args" type="java.lang.String[]"/>
  15075. <exception name="IOException" type="java.io.IOException"/>
  15076. </method>
  15077. <method name="createValueAggregatorJob" return="org.apache.hadoop.mapred.JobConf"
  15078. abstract="false" native="false" synchronized="false"
  15079. static="true" final="false" visibility="public"
  15080. deprecated="not deprecated">
  15081. <param name="args" type="java.lang.String[]"/>
  15082. <exception name="IOException" type="java.io.IOException"/>
  15083. <doc>
  15084. <![CDATA[Create an Aggregate based map/reduce job.
  15085. @param args the arguments used for job creation. Generic hadoop
  15086. arguments are accepted.
  15087. @return a JobConf object ready for submission.
  15088. @throws IOException
  15089. @see GenericOptionsParser]]>
  15090. </doc>
  15091. </method>
  15092. <method name="createValueAggregatorJob" return="org.apache.hadoop.mapred.JobConf"
  15093. abstract="false" native="false" synchronized="false"
  15094. static="true" final="false" visibility="public"
  15095. deprecated="not deprecated">
  15096. <param name="args" type="java.lang.String[]"/>
  15097. <param name="descriptors" type="java.lang.Class[]"/>
  15098. <exception name="IOException" type="java.io.IOException"/>
  15099. </method>
  15100. <method name="setAggregatorDescriptors"
  15101. abstract="false" native="false" synchronized="false"
  15102. static="true" final="false" visibility="public"
  15103. deprecated="not deprecated">
  15104. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  15105. <param name="descriptors" type="java.lang.Class[]"/>
  15106. </method>
  15107. <method name="main"
  15108. abstract="false" native="false" synchronized="false"
  15109. static="true" final="false" visibility="public"
  15110. deprecated="not deprecated">
  15111. <param name="args" type="java.lang.String[]"/>
  15112. <exception name="IOException" type="java.io.IOException"/>
  15113. <doc>
  15114. <![CDATA[create and run an Aggregate based map/reduce job.
  15115. @param args the arguments used for job creation
  15116. @throws IOException]]>
  15117. </doc>
  15118. </method>
  15119. <doc>
  15120. <![CDATA[This is the main class for creating a map/reduce job using Aggregate
  15121. framework. The Aggregate is a specialization of map/reduce framework,
  15122. specilizing for performing various simple aggregations.
  15123. Generally speaking, in order to implement an application using Map/Reduce
  15124. model, the developer is to implement Map and Reduce functions (and possibly
  15125. combine function). However, a lot of applications related to counting and
  15126. statistics computing have very similar characteristics. Aggregate abstracts
  15127. out the general patterns of these functions and implementing those patterns.
  15128. In particular, the package provides generic mapper/redducer/combiner classes,
  15129. and a set of built-in value aggregators, and a generic utility class that
  15130. helps user create map/reduce jobs using the generic class. The built-in
  15131. aggregators include:
  15132. sum over numeric values count the number of distinct values compute the
  15133. histogram of values compute the minimum, maximum, media,average, standard
  15134. deviation of numeric values
  15135. The developer using Aggregate will need only to provide a plugin class
  15136. conforming to the following interface:
  15137. public interface ValueAggregatorDescriptor { public ArrayList<Entry>
  15138. generateKeyValPairs(Object key, Object value); public void
  15139. configure(JobConfjob); }
  15140. The package also provides a base class, ValueAggregatorBaseDescriptor,
  15141. implementing the above interface. The user can extend the base class and
  15142. implement generateKeyValPairs accordingly.
  15143. The primary work of generateKeyValPairs is to emit one or more key/value
  15144. pairs based on the input key/value pair. The key in an output key/value pair
  15145. encode two pieces of information: aggregation type and aggregation id. The
  15146. value will be aggregated onto the aggregation id according the aggregation
  15147. type.
  15148. This class offers a function to generate a map/reduce job using Aggregate
  15149. framework. The function takes the following parameters: input directory spec
  15150. input format (text or sequence file) output directory a file specifying the
  15151. user plugin class]]>
  15152. </doc>
  15153. </class>
  15154. <!-- end class org.apache.hadoop.mapred.lib.aggregate.ValueAggregatorJob -->
  15155. <!-- start class org.apache.hadoop.mapred.lib.aggregate.ValueAggregatorJobBase -->
  15156. <class name="ValueAggregatorJobBase" extends="java.lang.Object"
  15157. abstract="true"
  15158. static="false" final="false" visibility="public"
  15159. deprecated="not deprecated">
  15160. <implements name="org.apache.hadoop.mapred.Mapper"/>
  15161. <implements name="org.apache.hadoop.mapred.Reducer"/>
  15162. <constructor name="ValueAggregatorJobBase"
  15163. static="false" final="false" visibility="public"
  15164. deprecated="not deprecated">
  15165. </constructor>
  15166. <method name="configure"
  15167. abstract="false" native="false" synchronized="false"
  15168. static="false" final="false" visibility="public"
  15169. deprecated="not deprecated">
  15170. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  15171. </method>
  15172. <method name="logSpec"
  15173. abstract="false" native="false" synchronized="false"
  15174. static="false" final="false" visibility="protected"
  15175. deprecated="not deprecated">
  15176. </method>
  15177. <method name="close"
  15178. abstract="false" native="false" synchronized="false"
  15179. static="false" final="false" visibility="public"
  15180. deprecated="not deprecated">
  15181. <exception name="IOException" type="java.io.IOException"/>
  15182. </method>
  15183. <field name="aggregatorDescriptorList" type="java.util.ArrayList"
  15184. transient="false" volatile="false"
  15185. static="false" final="false" visibility="protected"
  15186. deprecated="not deprecated">
  15187. </field>
  15188. <doc>
  15189. <![CDATA[This abstract class implements some common functionalities of the
  15190. the generic mapper, reducer and combiner classes of Aggregate.]]>
  15191. </doc>
  15192. </class>
  15193. <!-- end class org.apache.hadoop.mapred.lib.aggregate.ValueAggregatorJobBase -->
  15194. <!-- start class org.apache.hadoop.mapred.lib.aggregate.ValueAggregatorMapper -->
  15195. <class name="ValueAggregatorMapper" extends="org.apache.hadoop.mapred.lib.aggregate.ValueAggregatorJobBase"
  15196. abstract="false"
  15197. static="false" final="false" visibility="public"
  15198. deprecated="not deprecated">
  15199. <constructor name="ValueAggregatorMapper"
  15200. static="false" final="false" visibility="public"
  15201. deprecated="not deprecated">
  15202. </constructor>
  15203. <method name="map"
  15204. abstract="false" native="false" synchronized="false"
  15205. static="false" final="false" visibility="public"
  15206. deprecated="not deprecated">
  15207. <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
  15208. <param name="value" type="org.apache.hadoop.io.Writable"/>
  15209. <param name="output" type="org.apache.hadoop.mapred.OutputCollector"/>
  15210. <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
  15211. <exception name="IOException" type="java.io.IOException"/>
  15212. <doc>
  15213. <![CDATA[the map function. It iterates through the value aggregator descriptor
  15214. list to generate aggregation id/value pairs and emit them.]]>
  15215. </doc>
  15216. </method>
  15217. <method name="reduce"
  15218. abstract="false" native="false" synchronized="false"
  15219. static="false" final="false" visibility="public"
  15220. deprecated="not deprecated">
  15221. <param name="arg0" type="org.apache.hadoop.io.Text"/>
  15222. <param name="arg1" type="java.util.Iterator"/>
  15223. <param name="arg2" type="org.apache.hadoop.mapred.OutputCollector"/>
  15224. <param name="arg3" type="org.apache.hadoop.mapred.Reporter"/>
  15225. <exception name="IOException" type="java.io.IOException"/>
  15226. <doc>
  15227. <![CDATA[Do nothing. Should not be called.]]>
  15228. </doc>
  15229. </method>
  15230. <doc>
  15231. <![CDATA[This class implements the generic mapper of Aggregate.]]>
  15232. </doc>
  15233. </class>
  15234. <!-- end class org.apache.hadoop.mapred.lib.aggregate.ValueAggregatorMapper -->
  15235. <!-- start class org.apache.hadoop.mapred.lib.aggregate.ValueAggregatorReducer -->
  15236. <class name="ValueAggregatorReducer" extends="org.apache.hadoop.mapred.lib.aggregate.ValueAggregatorJobBase"
  15237. abstract="false"
  15238. static="false" final="false" visibility="public"
  15239. deprecated="not deprecated">
  15240. <constructor name="ValueAggregatorReducer"
  15241. static="false" final="false" visibility="public"
  15242. deprecated="not deprecated">
  15243. </constructor>
  15244. <method name="reduce"
  15245. abstract="false" native="false" synchronized="false"
  15246. static="false" final="false" visibility="public"
  15247. deprecated="not deprecated">
  15248. <param name="key" type="org.apache.hadoop.io.Text"/>
  15249. <param name="values" type="java.util.Iterator"/>
  15250. <param name="output" type="org.apache.hadoop.mapred.OutputCollector"/>
  15251. <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
  15252. <exception name="IOException" type="java.io.IOException"/>
  15253. <doc>
  15254. <![CDATA[@param key
  15255. the key is expected to be a Text object, whose prefix indicates
  15256. the type of aggregation to aggregate the values. In effect, data
  15257. driven computing is achieved. It is assumed that each aggregator's
  15258. getReport method emits appropriate output for the aggregator. This
  15259. may be further customiized.
  15260. @value the values to be aggregated]]>
  15261. </doc>
  15262. </method>
  15263. <method name="map"
  15264. abstract="false" native="false" synchronized="false"
  15265. static="false" final="false" visibility="public"
  15266. deprecated="not deprecated">
  15267. <param name="arg0" type="org.apache.hadoop.io.WritableComparable"/>
  15268. <param name="arg1" type="org.apache.hadoop.io.Writable"/>
  15269. <param name="arg2" type="org.apache.hadoop.mapred.OutputCollector"/>
  15270. <param name="arg3" type="org.apache.hadoop.mapred.Reporter"/>
  15271. <exception name="IOException" type="java.io.IOException"/>
  15272. <doc>
  15273. <![CDATA[Do nothing. Should not be called]]>
  15274. </doc>
  15275. </method>
  15276. <doc>
  15277. <![CDATA[This class implements the generic reducer of Aggregate.]]>
  15278. </doc>
  15279. </class>
  15280. <!-- end class org.apache.hadoop.mapred.lib.aggregate.ValueAggregatorReducer -->
  15281. <!-- start class org.apache.hadoop.mapred.lib.aggregate.ValueHistogram -->
  15282. <class name="ValueHistogram" extends="java.lang.Object"
  15283. abstract="false"
  15284. static="false" final="false" visibility="public"
  15285. deprecated="not deprecated">
  15286. <implements name="org.apache.hadoop.mapred.lib.aggregate.ValueAggregator"/>
  15287. <constructor name="ValueHistogram"
  15288. static="false" final="false" visibility="public"
  15289. deprecated="not deprecated">
  15290. </constructor>
  15291. <method name="addNextValue"
  15292. abstract="false" native="false" synchronized="false"
  15293. static="false" final="false" visibility="public"
  15294. deprecated="not deprecated">
  15295. <param name="val" type="java.lang.Object"/>
  15296. <doc>
  15297. <![CDATA[add the given val to the aggregator.
  15298. @param val the value to be added. It is expected to be a string
  15299. in the form of xxxx\tnum, meaning xxxx has num occurrences.]]>
  15300. </doc>
  15301. </method>
  15302. <method name="getReport" return="java.lang.String"
  15303. abstract="false" native="false" synchronized="false"
  15304. static="false" final="false" visibility="public"
  15305. deprecated="not deprecated">
  15306. <doc>
  15307. <![CDATA[@return the string representation of this aggregator.
  15308. It includes the following basic statistics of the histogram:
  15309. the number of unique values
  15310. the minimum value
  15311. the media value
  15312. the maximum value
  15313. the average value
  15314. the standard deviation]]>
  15315. </doc>
  15316. </method>
  15317. <method name="getReportDetails" return="java.lang.String"
  15318. abstract="false" native="false" synchronized="false"
  15319. static="false" final="false" visibility="public"
  15320. deprecated="not deprecated">
  15321. <doc>
  15322. <![CDATA[@return a string representation of the list of value/frequence pairs of
  15323. the histogram]]>
  15324. </doc>
  15325. </method>
  15326. <method name="getCombinerOutput" return="java.util.ArrayList"
  15327. abstract="false" native="false" synchronized="false"
  15328. static="false" final="false" visibility="public"
  15329. deprecated="not deprecated">
  15330. <doc>
  15331. <![CDATA[@return a list value/frequence pairs.
  15332. The return value is expected to be used by the reducer.]]>
  15333. </doc>
  15334. </method>
  15335. <method name="getReportItems" return="java.util.TreeMap"
  15336. abstract="false" native="false" synchronized="false"
  15337. static="false" final="false" visibility="public"
  15338. deprecated="not deprecated">
  15339. <doc>
  15340. <![CDATA[@return a TreeMap representation of the histogram]]>
  15341. </doc>
  15342. </method>
  15343. <method name="reset"
  15344. abstract="false" native="false" synchronized="false"
  15345. static="false" final="false" visibility="public"
  15346. deprecated="not deprecated">
  15347. <doc>
  15348. <![CDATA[reset the aggregator]]>
  15349. </doc>
  15350. </method>
  15351. <doc>
  15352. <![CDATA[This class implements a value aggregator that computes the
  15353. histogram of a sequence of strings.]]>
  15354. </doc>
  15355. </class>
  15356. <!-- end class org.apache.hadoop.mapred.lib.aggregate.ValueHistogram -->
  15357. </package>
  15358. <package name="org.apache.hadoop.mapred.lib.db">
  15359. <!-- start class org.apache.hadoop.mapred.lib.db.DBConfiguration -->
  15360. <class name="DBConfiguration" extends="java.lang.Object"
  15361. abstract="false"
  15362. static="false" final="false" visibility="public"
  15363. deprecated="not deprecated">
  15364. <method name="configureDB"
  15365. abstract="false" native="false" synchronized="false"
  15366. static="true" final="false" visibility="public"
  15367. deprecated="not deprecated">
  15368. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  15369. <param name="driverClass" type="java.lang.String"/>
  15370. <param name="dbUrl" type="java.lang.String"/>
  15371. <param name="userName" type="java.lang.String"/>
  15372. <param name="passwd" type="java.lang.String"/>
  15373. <doc>
  15374. <![CDATA[Sets the DB access related fields in the JobConf.
  15375. @param job the job
  15376. @param driverClass JDBC Driver class name
  15377. @param dbUrl JDBC DB access URL.
  15378. @param userName DB access username
  15379. @param passwd DB access passwd]]>
  15380. </doc>
  15381. </method>
  15382. <method name="configureDB"
  15383. abstract="false" native="false" synchronized="false"
  15384. static="true" final="false" visibility="public"
  15385. deprecated="not deprecated">
  15386. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  15387. <param name="driverClass" type="java.lang.String"/>
  15388. <param name="dbUrl" type="java.lang.String"/>
  15389. <doc>
  15390. <![CDATA[Sets the DB access related fields in the JobConf.
  15391. @param job the job
  15392. @param driverClass JDBC Driver class name
  15393. @param dbUrl JDBC DB access URL.]]>
  15394. </doc>
  15395. </method>
  15396. <field name="DRIVER_CLASS_PROPERTY" type="java.lang.String"
  15397. transient="false" volatile="false"
  15398. static="true" final="true" visibility="public"
  15399. deprecated="not deprecated">
  15400. <doc>
  15401. <![CDATA[The JDBC Driver class name]]>
  15402. </doc>
  15403. </field>
  15404. <field name="URL_PROPERTY" type="java.lang.String"
  15405. transient="false" volatile="false"
  15406. static="true" final="true" visibility="public"
  15407. deprecated="not deprecated">
  15408. <doc>
  15409. <![CDATA[JDBC Database access URL]]>
  15410. </doc>
  15411. </field>
  15412. <field name="USERNAME_PROPERTY" type="java.lang.String"
  15413. transient="false" volatile="false"
  15414. static="true" final="true" visibility="public"
  15415. deprecated="not deprecated">
  15416. <doc>
  15417. <![CDATA[User name to access the database]]>
  15418. </doc>
  15419. </field>
  15420. <field name="PASSWORD_PROPERTY" type="java.lang.String"
  15421. transient="false" volatile="false"
  15422. static="true" final="true" visibility="public"
  15423. deprecated="not deprecated">
  15424. <doc>
  15425. <![CDATA[Password to access the database]]>
  15426. </doc>
  15427. </field>
  15428. <field name="INPUT_TABLE_NAME_PROPERTY" type="java.lang.String"
  15429. transient="false" volatile="false"
  15430. static="true" final="true" visibility="public"
  15431. deprecated="not deprecated">
  15432. <doc>
  15433. <![CDATA[Input table name]]>
  15434. </doc>
  15435. </field>
  15436. <field name="INPUT_FIELD_NAMES_PROPERTY" type="java.lang.String"
  15437. transient="false" volatile="false"
  15438. static="true" final="true" visibility="public"
  15439. deprecated="not deprecated">
  15440. <doc>
  15441. <![CDATA[Field names in the Input table]]>
  15442. </doc>
  15443. </field>
  15444. <field name="INPUT_CONDITIONS_PROPERTY" type="java.lang.String"
  15445. transient="false" volatile="false"
  15446. static="true" final="true" visibility="public"
  15447. deprecated="not deprecated">
  15448. <doc>
  15449. <![CDATA[WHERE clause in the input SELECT statement]]>
  15450. </doc>
  15451. </field>
  15452. <field name="INPUT_ORDER_BY_PROPERTY" type="java.lang.String"
  15453. transient="false" volatile="false"
  15454. static="true" final="true" visibility="public"
  15455. deprecated="not deprecated">
  15456. <doc>
  15457. <![CDATA[ORDER BY clause in the input SELECT statement]]>
  15458. </doc>
  15459. </field>
  15460. <field name="INPUT_QUERY" type="java.lang.String"
  15461. transient="false" volatile="false"
  15462. static="true" final="true" visibility="public"
  15463. deprecated="not deprecated">
  15464. <doc>
  15465. <![CDATA[Whole input query, exluding LIMIT...OFFSET]]>
  15466. </doc>
  15467. </field>
  15468. <field name="INPUT_COUNT_QUERY" type="java.lang.String"
  15469. transient="false" volatile="false"
  15470. static="true" final="true" visibility="public"
  15471. deprecated="not deprecated">
  15472. <doc>
  15473. <![CDATA[Input query to get the count of records]]>
  15474. </doc>
  15475. </field>
  15476. <field name="INPUT_CLASS_PROPERTY" type="java.lang.String"
  15477. transient="false" volatile="false"
  15478. static="true" final="true" visibility="public"
  15479. deprecated="not deprecated">
  15480. <doc>
  15481. <![CDATA[Class name implementing DBWritable which will hold input tuples]]>
  15482. </doc>
  15483. </field>
  15484. <field name="OUTPUT_TABLE_NAME_PROPERTY" type="java.lang.String"
  15485. transient="false" volatile="false"
  15486. static="true" final="true" visibility="public"
  15487. deprecated="not deprecated">
  15488. <doc>
  15489. <![CDATA[Output table name]]>
  15490. </doc>
  15491. </field>
  15492. <field name="OUTPUT_FIELD_NAMES_PROPERTY" type="java.lang.String"
  15493. transient="false" volatile="false"
  15494. static="true" final="true" visibility="public"
  15495. deprecated="not deprecated">
  15496. <doc>
  15497. <![CDATA[Field names in the Output table]]>
  15498. </doc>
  15499. </field>
  15500. <doc>
  15501. <![CDATA[A container for configuration property names for jobs with DB input/output.
  15502. <br>
  15503. The job can be configured using the static methods in this class,
  15504. {@link DBInputFormat}, and {@link DBOutputFormat}.
  15505. <p>
  15506. Alternatively, the properties can be set in the configuration with proper
  15507. values.
  15508. @see DBConfiguration#configureDB(JobConf, String, String, String, String)
  15509. @see DBInputFormat#setInput(JobConf, Class, String, String)
  15510. @see DBInputFormat#setInput(JobConf, Class, String, String, String, String...)
  15511. @see DBOutputFormat#setOutput(JobConf, String, String...)]]>
  15512. </doc>
  15513. </class>
  15514. <!-- end class org.apache.hadoop.mapred.lib.db.DBConfiguration -->
  15515. <!-- start class org.apache.hadoop.mapred.lib.db.DBInputFormat -->
  15516. <class name="DBInputFormat" extends="java.lang.Object"
  15517. abstract="false"
  15518. static="false" final="false" visibility="public"
  15519. deprecated="not deprecated">
  15520. <implements name="org.apache.hadoop.mapred.InputFormat"/>
  15521. <implements name="org.apache.hadoop.mapred.JobConfigurable"/>
  15522. <constructor name="DBInputFormat"
  15523. static="false" final="false" visibility="public"
  15524. deprecated="not deprecated">
  15525. </constructor>
  15526. <method name="configure"
  15527. abstract="false" native="false" synchronized="false"
  15528. static="false" final="false" visibility="public"
  15529. deprecated="not deprecated">
  15530. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  15531. <doc>
  15532. <![CDATA[{@inheritDoc}]]>
  15533. </doc>
  15534. </method>
  15535. <method name="getRecordReader" return="org.apache.hadoop.mapred.RecordReader"
  15536. abstract="false" native="false" synchronized="false"
  15537. static="false" final="false" visibility="public"
  15538. deprecated="not deprecated">
  15539. <param name="split" type="org.apache.hadoop.mapred.InputSplit"/>
  15540. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  15541. <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
  15542. <exception name="IOException" type="java.io.IOException"/>
  15543. <doc>
  15544. <![CDATA[{@inheritDoc}]]>
  15545. </doc>
  15546. </method>
  15547. <method name="getSplits" return="org.apache.hadoop.mapred.InputSplit[]"
  15548. abstract="false" native="false" synchronized="false"
  15549. static="false" final="false" visibility="public"
  15550. deprecated="not deprecated">
  15551. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  15552. <param name="chunks" type="int"/>
  15553. <exception name="IOException" type="java.io.IOException"/>
  15554. <doc>
  15555. <![CDATA[{@inheritDoc}]]>
  15556. </doc>
  15557. </method>
  15558. <method name="getCountQuery" return="java.lang.String"
  15559. abstract="false" native="false" synchronized="false"
  15560. static="false" final="false" visibility="protected"
  15561. deprecated="not deprecated">
  15562. <doc>
  15563. <![CDATA[Returns the query for getting the total number of rows,
  15564. subclasses can override this for custom behaviour.]]>
  15565. </doc>
  15566. </method>
  15567. <method name="setInput"
  15568. abstract="false" native="false" synchronized="false"
  15569. static="true" final="false" visibility="public"
  15570. deprecated="not deprecated">
  15571. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  15572. <param name="inputClass" type="java.lang.Class"/>
  15573. <param name="tableName" type="java.lang.String"/>
  15574. <param name="conditions" type="java.lang.String"/>
  15575. <param name="orderBy" type="java.lang.String"/>
  15576. <param name="fieldNames" type="java.lang.String[]"/>
  15577. <doc>
  15578. <![CDATA[Initializes the map-part of the job with the appropriate input settings.
  15579. @param job The job
  15580. @param inputClass the class object implementing DBWritable, which is the
  15581. Java object holding tuple fields.
  15582. @param tableName The table to read data from
  15583. @param conditions The condition which to select data with, eg. '(updated >
  15584. 20070101 AND length > 0)'
  15585. @param orderBy the fieldNames in the orderBy clause.
  15586. @param fieldNames The field names in the table
  15587. @see #setInput(JobConf, Class, String, String)]]>
  15588. </doc>
  15589. </method>
  15590. <method name="setInput"
  15591. abstract="false" native="false" synchronized="false"
  15592. static="true" final="false" visibility="public"
  15593. deprecated="not deprecated">
  15594. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  15595. <param name="inputClass" type="java.lang.Class"/>
  15596. <param name="inputQuery" type="java.lang.String"/>
  15597. <param name="inputCountQuery" type="java.lang.String"/>
  15598. <doc>
  15599. <![CDATA[Initializes the map-part of the job with the appropriate input settings.
  15600. @param job The job
  15601. @param inputClass the class object implementing DBWritable, which is the
  15602. Java object holding tuple fields.
  15603. @param inputQuery the input query to select fields. Example :
  15604. "SELECT f1, f2, f3 FROM Mytable ORDER BY f1"
  15605. @param inputCountQuery the input query that returns the number of records in
  15606. the table.
  15607. Example : "SELECT COUNT(f1) FROM Mytable"
  15608. @see #setInput(JobConf, Class, String, String, String, String...)]]>
  15609. </doc>
  15610. </method>
  15611. <doc>
  15612. <![CDATA[A InputFormat that reads input data from an SQL table.
  15613. <p>
  15614. DBInputFormat emits LongWritables containing the record number as
  15615. key and DBWritables as value.
  15616. The SQL query, and input class can be using one of the two
  15617. setInput methods.]]>
  15618. </doc>
  15619. </class>
  15620. <!-- end class org.apache.hadoop.mapred.lib.db.DBInputFormat -->
  15621. <!-- start class org.apache.hadoop.mapred.lib.db.DBInputFormat.DBInputSplit -->
  15622. <class name="DBInputFormat.DBInputSplit" extends="java.lang.Object"
  15623. abstract="false"
  15624. static="true" final="false" visibility="protected"
  15625. deprecated="not deprecated">
  15626. <implements name="org.apache.hadoop.mapred.InputSplit"/>
  15627. <constructor name="DBInputFormat.DBInputSplit"
  15628. static="false" final="false" visibility="public"
  15629. deprecated="not deprecated">
  15630. <doc>
  15631. <![CDATA[Default Constructor]]>
  15632. </doc>
  15633. </constructor>
  15634. <constructor name="DBInputFormat.DBInputSplit" type="long, long"
  15635. static="false" final="false" visibility="public"
  15636. deprecated="not deprecated">
  15637. <doc>
  15638. <![CDATA[Convenience Constructor
  15639. @param start the index of the first row to select
  15640. @param end the index of the last row to select]]>
  15641. </doc>
  15642. </constructor>
  15643. <method name="getLocations" return="java.lang.String[]"
  15644. abstract="false" native="false" synchronized="false"
  15645. static="false" final="false" visibility="public"
  15646. deprecated="not deprecated">
  15647. <exception name="IOException" type="java.io.IOException"/>
  15648. <doc>
  15649. <![CDATA[{@inheritDoc}]]>
  15650. </doc>
  15651. </method>
  15652. <method name="getStart" return="long"
  15653. abstract="false" native="false" synchronized="false"
  15654. static="false" final="false" visibility="public"
  15655. deprecated="not deprecated">
  15656. <doc>
  15657. <![CDATA[@return The index of the first row to select]]>
  15658. </doc>
  15659. </method>
  15660. <method name="getEnd" return="long"
  15661. abstract="false" native="false" synchronized="false"
  15662. static="false" final="false" visibility="public"
  15663. deprecated="not deprecated">
  15664. <doc>
  15665. <![CDATA[@return The index of the last row to select]]>
  15666. </doc>
  15667. </method>
  15668. <method name="getLength" return="long"
  15669. abstract="false" native="false" synchronized="false"
  15670. static="false" final="false" visibility="public"
  15671. deprecated="not deprecated">
  15672. <exception name="IOException" type="java.io.IOException"/>
  15673. <doc>
  15674. <![CDATA[@return The total row count in this split]]>
  15675. </doc>
  15676. </method>
  15677. <method name="readFields"
  15678. abstract="false" native="false" synchronized="false"
  15679. static="false" final="false" visibility="public"
  15680. deprecated="not deprecated">
  15681. <param name="input" type="java.io.DataInput"/>
  15682. <exception name="IOException" type="java.io.IOException"/>
  15683. <doc>
  15684. <![CDATA[{@inheritDoc}]]>
  15685. </doc>
  15686. </method>
  15687. <method name="write"
  15688. abstract="false" native="false" synchronized="false"
  15689. static="false" final="false" visibility="public"
  15690. deprecated="not deprecated">
  15691. <param name="output" type="java.io.DataOutput"/>
  15692. <exception name="IOException" type="java.io.IOException"/>
  15693. <doc>
  15694. <![CDATA[{@inheritDoc}]]>
  15695. </doc>
  15696. </method>
  15697. <doc>
  15698. <![CDATA[A InputSplit that spans a set of rows]]>
  15699. </doc>
  15700. </class>
  15701. <!-- end class org.apache.hadoop.mapred.lib.db.DBInputFormat.DBInputSplit -->
  15702. <!-- start class org.apache.hadoop.mapred.lib.db.DBInputFormat.DBRecordReader -->
  15703. <class name="DBInputFormat.DBRecordReader" extends="java.lang.Object"
  15704. abstract="false"
  15705. static="false" final="false" visibility="protected"
  15706. deprecated="not deprecated">
  15707. <implements name="org.apache.hadoop.mapred.RecordReader"/>
  15708. <constructor name="DBInputFormat.DBRecordReader" type="org.apache.hadoop.mapred.lib.db.DBInputFormat.DBInputSplit, java.lang.Class, org.apache.hadoop.mapred.JobConf"
  15709. static="false" final="false" visibility="protected"
  15710. deprecated="not deprecated">
  15711. <exception name="SQLException" type="java.sql.SQLException"/>
  15712. <doc>
  15713. <![CDATA[@param split The InputSplit to read data for
  15714. @throws SQLException]]>
  15715. </doc>
  15716. </constructor>
  15717. <method name="getSelectQuery" return="java.lang.String"
  15718. abstract="false" native="false" synchronized="false"
  15719. static="false" final="false" visibility="protected"
  15720. deprecated="not deprecated">
  15721. <doc>
  15722. <![CDATA[Returns the query for selecting the records,
  15723. subclasses can override this for custom behaviour.]]>
  15724. </doc>
  15725. </method>
  15726. <method name="close"
  15727. abstract="false" native="false" synchronized="false"
  15728. static="false" final="false" visibility="public"
  15729. deprecated="not deprecated">
  15730. <exception name="IOException" type="java.io.IOException"/>
  15731. <doc>
  15732. <![CDATA[{@inheritDoc}]]>
  15733. </doc>
  15734. </method>
  15735. <method name="createKey" return="org.apache.hadoop.io.LongWritable"
  15736. abstract="false" native="false" synchronized="false"
  15737. static="false" final="false" visibility="public"
  15738. deprecated="not deprecated">
  15739. <doc>
  15740. <![CDATA[{@inheritDoc}]]>
  15741. </doc>
  15742. </method>
  15743. <method name="createValue" return="org.apache.hadoop.mapred.lib.db.DBWritable"
  15744. abstract="false" native="false" synchronized="false"
  15745. static="false" final="false" visibility="public"
  15746. deprecated="not deprecated">
  15747. <doc>
  15748. <![CDATA[{@inheritDoc}]]>
  15749. </doc>
  15750. </method>
  15751. <method name="getPos" return="long"
  15752. abstract="false" native="false" synchronized="false"
  15753. static="false" final="false" visibility="public"
  15754. deprecated="not deprecated">
  15755. <exception name="IOException" type="java.io.IOException"/>
  15756. <doc>
  15757. <![CDATA[{@inheritDoc}]]>
  15758. </doc>
  15759. </method>
  15760. <method name="getProgress" return="float"
  15761. abstract="false" native="false" synchronized="false"
  15762. static="false" final="false" visibility="public"
  15763. deprecated="not deprecated">
  15764. <exception name="IOException" type="java.io.IOException"/>
  15765. <doc>
  15766. <![CDATA[{@inheritDoc}]]>
  15767. </doc>
  15768. </method>
  15769. <method name="next" return="boolean"
  15770. abstract="false" native="false" synchronized="false"
  15771. static="false" final="false" visibility="public"
  15772. deprecated="not deprecated">
  15773. <param name="key" type="org.apache.hadoop.io.LongWritable"/>
  15774. <param name="value" type="org.apache.hadoop.mapred.lib.db.DBWritable"/>
  15775. <exception name="IOException" type="java.io.IOException"/>
  15776. <doc>
  15777. <![CDATA[{@inheritDoc}]]>
  15778. </doc>
  15779. </method>
  15780. <doc>
  15781. <![CDATA[A RecordReader that reads records from a SQL table.
  15782. Emits LongWritables containing the record number as
  15783. key and DBWritables as value.]]>
  15784. </doc>
  15785. </class>
  15786. <!-- end class org.apache.hadoop.mapred.lib.db.DBInputFormat.DBRecordReader -->
  15787. <!-- start class org.apache.hadoop.mapred.lib.db.DBInputFormat.NullDBWritable -->
  15788. <class name="DBInputFormat.NullDBWritable" extends="java.lang.Object"
  15789. abstract="false"
  15790. static="true" final="false" visibility="public"
  15791. deprecated="not deprecated">
  15792. <implements name="org.apache.hadoop.mapred.lib.db.DBWritable"/>
  15793. <implements name="org.apache.hadoop.io.Writable"/>
  15794. <constructor name="DBInputFormat.NullDBWritable"
  15795. static="false" final="false" visibility="public"
  15796. deprecated="not deprecated">
  15797. </constructor>
  15798. <method name="readFields"
  15799. abstract="false" native="false" synchronized="false"
  15800. static="false" final="false" visibility="public"
  15801. deprecated="not deprecated">
  15802. <param name="in" type="java.io.DataInput"/>
  15803. <exception name="IOException" type="java.io.IOException"/>
  15804. </method>
  15805. <method name="readFields"
  15806. abstract="false" native="false" synchronized="false"
  15807. static="false" final="false" visibility="public"
  15808. deprecated="not deprecated">
  15809. <param name="arg0" type="java.sql.ResultSet"/>
  15810. <exception name="SQLException" type="java.sql.SQLException"/>
  15811. </method>
  15812. <method name="write"
  15813. abstract="false" native="false" synchronized="false"
  15814. static="false" final="false" visibility="public"
  15815. deprecated="not deprecated">
  15816. <param name="out" type="java.io.DataOutput"/>
  15817. <exception name="IOException" type="java.io.IOException"/>
  15818. </method>
  15819. <method name="write"
  15820. abstract="false" native="false" synchronized="false"
  15821. static="false" final="false" visibility="public"
  15822. deprecated="not deprecated">
  15823. <param name="arg0" type="java.sql.PreparedStatement"/>
  15824. <exception name="SQLException" type="java.sql.SQLException"/>
  15825. </method>
  15826. <doc>
  15827. <![CDATA[A Class that does nothing, implementing DBWritable]]>
  15828. </doc>
  15829. </class>
  15830. <!-- end class org.apache.hadoop.mapred.lib.db.DBInputFormat.NullDBWritable -->
  15831. <!-- start class org.apache.hadoop.mapred.lib.db.DBOutputFormat -->
  15832. <class name="DBOutputFormat" extends="java.lang.Object"
  15833. abstract="false"
  15834. static="false" final="false" visibility="public"
  15835. deprecated="not deprecated">
  15836. <implements name="org.apache.hadoop.mapred.OutputFormat"/>
  15837. <constructor name="DBOutputFormat"
  15838. static="false" final="false" visibility="public"
  15839. deprecated="not deprecated">
  15840. </constructor>
  15841. <method name="constructQuery" return="java.lang.String"
  15842. abstract="false" native="false" synchronized="false"
  15843. static="false" final="false" visibility="protected"
  15844. deprecated="not deprecated">
  15845. <param name="table" type="java.lang.String"/>
  15846. <param name="fieldNames" type="java.lang.String[]"/>
  15847. <doc>
  15848. <![CDATA[Constructs the query used as the prepared statement to insert data.
  15849. @param table
  15850. the table to insert into
  15851. @param fieldNames
  15852. the fields to insert into. If field names are unknown, supply an
  15853. array of nulls.]]>
  15854. </doc>
  15855. </method>
  15856. <method name="checkOutputSpecs"
  15857. abstract="false" native="false" synchronized="false"
  15858. static="false" final="false" visibility="public"
  15859. deprecated="not deprecated">
  15860. <param name="filesystem" type="org.apache.hadoop.fs.FileSystem"/>
  15861. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  15862. <exception name="IOException" type="java.io.IOException"/>
  15863. <doc>
  15864. <![CDATA[{@inheritDoc}]]>
  15865. </doc>
  15866. </method>
  15867. <method name="getRecordWriter" return="org.apache.hadoop.mapred.RecordWriter"
  15868. abstract="false" native="false" synchronized="false"
  15869. static="false" final="false" visibility="public"
  15870. deprecated="not deprecated">
  15871. <param name="filesystem" type="org.apache.hadoop.fs.FileSystem"/>
  15872. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  15873. <param name="name" type="java.lang.String"/>
  15874. <param name="progress" type="org.apache.hadoop.util.Progressable"/>
  15875. <exception name="IOException" type="java.io.IOException"/>
  15876. <doc>
  15877. <![CDATA[{@inheritDoc}]]>
  15878. </doc>
  15879. </method>
  15880. <method name="setOutput"
  15881. abstract="false" native="false" synchronized="false"
  15882. static="true" final="false" visibility="public"
  15883. deprecated="not deprecated">
  15884. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  15885. <param name="tableName" type="java.lang.String"/>
  15886. <param name="fieldNames" type="java.lang.String[]"/>
  15887. <doc>
  15888. <![CDATA[Initializes the reduce-part of the job with the appropriate output settings
  15889. @param job
  15890. The job
  15891. @param tableName
  15892. The table to insert data into
  15893. @param fieldNames
  15894. The field names in the table. If unknown, supply the appropriate
  15895. number of nulls.]]>
  15896. </doc>
  15897. </method>
  15898. <doc>
  15899. <![CDATA[A OutputFormat that sends the reduce output to a SQL table.
  15900. <p>
  15901. {@link DBOutputFormat} accepts &lt;key,value&gt; pairs, where
  15902. key has a type extending DBWritable. Returned {@link RecordWriter}
  15903. writes <b>only the key</b> to the database with a batch SQL query.]]>
  15904. </doc>
  15905. </class>
  15906. <!-- end class org.apache.hadoop.mapred.lib.db.DBOutputFormat -->
  15907. <!-- start class org.apache.hadoop.mapred.lib.db.DBOutputFormat.DBRecordWriter -->
  15908. <class name="DBOutputFormat.DBRecordWriter" extends="java.lang.Object"
  15909. abstract="false"
  15910. static="false" final="false" visibility="protected"
  15911. deprecated="not deprecated">
  15912. <implements name="org.apache.hadoop.mapred.RecordWriter"/>
  15913. <constructor name="DBOutputFormat.DBRecordWriter" type="java.sql.Connection, java.sql.PreparedStatement"
  15914. static="false" final="false" visibility="protected"
  15915. deprecated="not deprecated">
  15916. <exception name="SQLException" type="java.sql.SQLException"/>
  15917. </constructor>
  15918. <method name="close"
  15919. abstract="false" native="false" synchronized="false"
  15920. static="false" final="false" visibility="public"
  15921. deprecated="not deprecated">
  15922. <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
  15923. <exception name="IOException" type="java.io.IOException"/>
  15924. <doc>
  15925. <![CDATA[{@inheritDoc}]]>
  15926. </doc>
  15927. </method>
  15928. <method name="write"
  15929. abstract="false" native="false" synchronized="false"
  15930. static="false" final="false" visibility="public"
  15931. deprecated="not deprecated">
  15932. <param name="key" type="org.apache.hadoop.mapred.lib.db.DBWritable"/>
  15933. <param name="value" type="java.lang.Object"/>
  15934. <exception name="IOException" type="java.io.IOException"/>
  15935. <doc>
  15936. <![CDATA[{@inheritDoc}]]>
  15937. </doc>
  15938. </method>
  15939. <doc>
  15940. <![CDATA[A RecordWriter that writes the reduce output to a SQL table]]>
  15941. </doc>
  15942. </class>
  15943. <!-- end class org.apache.hadoop.mapred.lib.db.DBOutputFormat.DBRecordWriter -->
  15944. <!-- start interface org.apache.hadoop.mapred.lib.db.DBWritable -->
  15945. <interface name="DBWritable" abstract="true"
  15946. static="false" final="false" visibility="public"
  15947. deprecated="not deprecated">
  15948. <method name="write"
  15949. abstract="false" native="false" synchronized="false"
  15950. static="false" final="false" visibility="public"
  15951. deprecated="not deprecated">
  15952. <param name="statement" type="java.sql.PreparedStatement"/>
  15953. <exception name="SQLException" type="java.sql.SQLException"/>
  15954. <doc>
  15955. <![CDATA[Sets the fields of the object in the {@link PreparedStatement}.
  15956. @param statement the statement that the fields are put into.
  15957. @throws SQLException]]>
  15958. </doc>
  15959. </method>
  15960. <method name="readFields"
  15961. abstract="false" native="false" synchronized="false"
  15962. static="false" final="false" visibility="public"
  15963. deprecated="not deprecated">
  15964. <param name="resultSet" type="java.sql.ResultSet"/>
  15965. <exception name="SQLException" type="java.sql.SQLException"/>
  15966. <doc>
  15967. <![CDATA[Reads the fields of the object from the {@link ResultSet}.
  15968. @param resultSet the {@link ResultSet} to get the fields from.
  15969. @throws SQLException]]>
  15970. </doc>
  15971. </method>
  15972. <doc>
  15973. <![CDATA[Objects that are read from/written to a database should implement
  15974. <code>DBWritable</code>. DBWritable, is similar to {@link Writable}
  15975. except that the {@link #write(PreparedStatement)} method takes a
  15976. {@link PreparedStatement}, and {@link #readFields(ResultSet)}
  15977. takes a {@link ResultSet}.
  15978. <p>
  15979. Implementations are responsible for writing the fields of the object
  15980. to PreparedStatement, and reading the fields of the object from the
  15981. ResultSet.
  15982. <p>Example:</p>
  15983. If we have the following table in the database :
  15984. <pre>
  15985. CREATE TABLE MyTable (
  15986. counter INTEGER NOT NULL,
  15987. timestamp BIGINT NOT NULL,
  15988. );
  15989. </pre>
  15990. then we can read/write the tuples from/to the table with :
  15991. <p><pre>
  15992. public class MyWritable implements Writable, DBWritable {
  15993. // Some data
  15994. private int counter;
  15995. private long timestamp;
  15996. //Writable#write() implementation
  15997. public void write(DataOutput out) throws IOException {
  15998. out.writeInt(counter);
  15999. out.writeLong(timestamp);
  16000. }
  16001. //Writable#readFields() implementation
  16002. public void readFields(DataInput in) throws IOException {
  16003. counter = in.readInt();
  16004. timestamp = in.readLong();
  16005. }
  16006. public void write(PreparedStatement statement) throws SQLException {
  16007. statement.setInt(1, counter);
  16008. statement.setLong(2, timestamp);
  16009. }
  16010. public void readFields(ResultSet resultSet) throws SQLException {
  16011. counter = resultSet.getInt(1);
  16012. timestamp = resultSet.getLong(2);
  16013. }
  16014. }
  16015. </pre></p>]]>
  16016. </doc>
  16017. </interface>
  16018. <!-- end interface org.apache.hadoop.mapred.lib.db.DBWritable -->
  16019. </package>
  16020. <package name="org.apache.hadoop.mapred.pipes">
  16021. <!-- start class org.apache.hadoop.mapred.pipes.Submitter -->
  16022. <class name="Submitter" extends="org.apache.hadoop.conf.Configured"
  16023. abstract="false"
  16024. static="false" final="false" visibility="public"
  16025. deprecated="not deprecated">
  16026. <implements name="org.apache.hadoop.util.Tool"/>
  16027. <constructor name="Submitter"
  16028. static="false" final="false" visibility="public"
  16029. deprecated="not deprecated">
  16030. </constructor>
  16031. <constructor name="Submitter" type="org.apache.hadoop.conf.Configuration"
  16032. static="false" final="false" visibility="public"
  16033. deprecated="not deprecated">
  16034. </constructor>
  16035. <method name="getExecutable" return="java.lang.String"
  16036. abstract="false" native="false" synchronized="false"
  16037. static="true" final="false" visibility="public"
  16038. deprecated="not deprecated">
  16039. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  16040. <doc>
  16041. <![CDATA[Get the URI of the application's executable.
  16042. @param conf
  16043. @return the URI where the application's executable is located]]>
  16044. </doc>
  16045. </method>
  16046. <method name="setExecutable"
  16047. abstract="false" native="false" synchronized="false"
  16048. static="true" final="false" visibility="public"
  16049. deprecated="not deprecated">
  16050. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  16051. <param name="executable" type="java.lang.String"/>
  16052. <doc>
  16053. <![CDATA[Set the URI for the application's executable. Normally this is a hdfs:
  16054. location.
  16055. @param conf
  16056. @param executable The URI of the application's executable.]]>
  16057. </doc>
  16058. </method>
  16059. <method name="setIsJavaRecordReader"
  16060. abstract="false" native="false" synchronized="false"
  16061. static="true" final="false" visibility="public"
  16062. deprecated="not deprecated">
  16063. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  16064. <param name="value" type="boolean"/>
  16065. <doc>
  16066. <![CDATA[Set whether the job is using a Java RecordReader.
  16067. @param conf the configuration to modify
  16068. @param value the new value]]>
  16069. </doc>
  16070. </method>
  16071. <method name="getIsJavaRecordReader" return="boolean"
  16072. abstract="false" native="false" synchronized="false"
  16073. static="true" final="false" visibility="public"
  16074. deprecated="not deprecated">
  16075. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  16076. <doc>
  16077. <![CDATA[Check whether the job is using a Java RecordReader
  16078. @param conf the configuration to check
  16079. @return is it a Java RecordReader?]]>
  16080. </doc>
  16081. </method>
  16082. <method name="setIsJavaMapper"
  16083. abstract="false" native="false" synchronized="false"
  16084. static="true" final="false" visibility="public"
  16085. deprecated="not deprecated">
  16086. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  16087. <param name="value" type="boolean"/>
  16088. <doc>
  16089. <![CDATA[Set whether the Mapper is written in Java.
  16090. @param conf the configuration to modify
  16091. @param value the new value]]>
  16092. </doc>
  16093. </method>
  16094. <method name="getIsJavaMapper" return="boolean"
  16095. abstract="false" native="false" synchronized="false"
  16096. static="true" final="false" visibility="public"
  16097. deprecated="not deprecated">
  16098. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  16099. <doc>
  16100. <![CDATA[Check whether the job is using a Java Mapper.
  16101. @param conf the configuration to check
  16102. @return is it a Java Mapper?]]>
  16103. </doc>
  16104. </method>
  16105. <method name="setIsJavaReducer"
  16106. abstract="false" native="false" synchronized="false"
  16107. static="true" final="false" visibility="public"
  16108. deprecated="not deprecated">
  16109. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  16110. <param name="value" type="boolean"/>
  16111. <doc>
  16112. <![CDATA[Set whether the Reducer is written in Java.
  16113. @param conf the configuration to modify
  16114. @param value the new value]]>
  16115. </doc>
  16116. </method>
  16117. <method name="getIsJavaReducer" return="boolean"
  16118. abstract="false" native="false" synchronized="false"
  16119. static="true" final="false" visibility="public"
  16120. deprecated="not deprecated">
  16121. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  16122. <doc>
  16123. <![CDATA[Check whether the job is using a Java Reducer.
  16124. @param conf the configuration to check
  16125. @return is it a Java Reducer?]]>
  16126. </doc>
  16127. </method>
  16128. <method name="setIsJavaRecordWriter"
  16129. abstract="false" native="false" synchronized="false"
  16130. static="true" final="false" visibility="public"
  16131. deprecated="not deprecated">
  16132. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  16133. <param name="value" type="boolean"/>
  16134. <doc>
  16135. <![CDATA[Set whether the job will use a Java RecordWriter.
  16136. @param conf the configuration to modify
  16137. @param value the new value to set]]>
  16138. </doc>
  16139. </method>
  16140. <method name="getIsJavaRecordWriter" return="boolean"
  16141. abstract="false" native="false" synchronized="false"
  16142. static="true" final="false" visibility="public"
  16143. deprecated="not deprecated">
  16144. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  16145. <doc>
  16146. <![CDATA[Will the reduce use a Java RecordWriter?
  16147. @param conf the configuration to check
  16148. @return true, if the output of the job will be written by Java]]>
  16149. </doc>
  16150. </method>
  16151. <method name="getKeepCommandFile" return="boolean"
  16152. abstract="false" native="false" synchronized="false"
  16153. static="true" final="false" visibility="public"
  16154. deprecated="not deprecated">
  16155. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  16156. <doc>
  16157. <![CDATA[Does the user want to keep the command file for debugging? If this is
  16158. true, pipes will write a copy of the command data to a file in the
  16159. task directory named "downlink.data", which may be used to run the C++
  16160. program under the debugger. You probably also want to set
  16161. JobConf.setKeepFailedTaskFiles(true) to keep the entire directory from
  16162. being deleted.
  16163. To run using the data file, set the environment variable
  16164. "hadoop.pipes.command.file" to point to the file.
  16165. @param conf the configuration to check
  16166. @return will the framework save the command file?]]>
  16167. </doc>
  16168. </method>
  16169. <method name="setKeepCommandFile"
  16170. abstract="false" native="false" synchronized="false"
  16171. static="true" final="false" visibility="public"
  16172. deprecated="not deprecated">
  16173. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  16174. <param name="keep" type="boolean"/>
  16175. <doc>
  16176. <![CDATA[Set whether to keep the command file for debugging
  16177. @param conf the configuration to modify
  16178. @param keep the new value]]>
  16179. </doc>
  16180. </method>
  16181. <method name="submitJob" return="org.apache.hadoop.mapred.RunningJob"
  16182. abstract="false" native="false" synchronized="false"
  16183. static="true" final="false" visibility="public"
  16184. deprecated="Use {@link Submitter#runJob(JobConf)}">
  16185. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  16186. <exception name="IOException" type="java.io.IOException"/>
  16187. <doc>
  16188. <![CDATA[Submit a job to the map/reduce cluster. All of the necessary modifications
  16189. to the job to run under pipes are made to the configuration.
  16190. @param conf the job to submit to the cluster (MODIFIED)
  16191. @throws IOException
  16192. @deprecated Use {@link Submitter#runJob(JobConf)}]]>
  16193. </doc>
  16194. </method>
  16195. <method name="runJob" return="org.apache.hadoop.mapred.RunningJob"
  16196. abstract="false" native="false" synchronized="false"
  16197. static="true" final="false" visibility="public"
  16198. deprecated="not deprecated">
  16199. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  16200. <exception name="IOException" type="java.io.IOException"/>
  16201. <doc>
  16202. <![CDATA[Submit a job to the map/reduce cluster. All of the necessary modifications
  16203. to the job to run under pipes are made to the configuration.
  16204. @param conf the job to submit to the cluster (MODIFIED)
  16205. @throws IOException]]>
  16206. </doc>
  16207. </method>
  16208. <method name="jobSubmit" return="org.apache.hadoop.mapred.RunningJob"
  16209. abstract="false" native="false" synchronized="false"
  16210. static="true" final="false" visibility="public"
  16211. deprecated="not deprecated">
  16212. <param name="conf" type="org.apache.hadoop.mapred.JobConf"/>
  16213. <exception name="IOException" type="java.io.IOException"/>
  16214. <doc>
  16215. <![CDATA[Submit a job to the Map-Reduce framework.
  16216. This returns a handle to the {@link RunningJob} which can be used to track
  16217. the running-job.
  16218. @param conf the job configuration.
  16219. @return a handle to the {@link RunningJob} which can be used to track the
  16220. running-job.
  16221. @throws IOException]]>
  16222. </doc>
  16223. </method>
  16224. <method name="run" return="int"
  16225. abstract="false" native="false" synchronized="false"
  16226. static="false" final="false" visibility="public"
  16227. deprecated="not deprecated">
  16228. <param name="args" type="java.lang.String[]"/>
  16229. <exception name="Exception" type="java.lang.Exception"/>
  16230. </method>
  16231. <method name="main"
  16232. abstract="false" native="false" synchronized="false"
  16233. static="true" final="false" visibility="public"
  16234. deprecated="not deprecated">
  16235. <param name="args" type="java.lang.String[]"/>
  16236. <exception name="Exception" type="java.lang.Exception"/>
  16237. <doc>
  16238. <![CDATA[Submit a pipes job based on the command line arguments.
  16239. @param args]]>
  16240. </doc>
  16241. </method>
  16242. <field name="LOG" type="org.apache.commons.logging.Log"
  16243. transient="false" volatile="false"
  16244. static="true" final="true" visibility="protected"
  16245. deprecated="not deprecated">
  16246. </field>
  16247. <doc>
  16248. <![CDATA[The main entry point and job submitter. It may either be used as a command
  16249. line-based or API-based method to launch Pipes jobs.]]>
  16250. </doc>
  16251. </class>
  16252. <!-- end class org.apache.hadoop.mapred.pipes.Submitter -->
  16253. </package>
  16254. <package name="org.apache.hadoop.mapred.tools">
  16255. <!-- start class org.apache.hadoop.mapred.tools.MRAdmin -->
  16256. <class name="MRAdmin" extends="org.apache.hadoop.conf.Configured"
  16257. abstract="false"
  16258. static="false" final="false" visibility="public"
  16259. deprecated="not deprecated">
  16260. <implements name="org.apache.hadoop.util.Tool"/>
  16261. <constructor name="MRAdmin"
  16262. static="false" final="false" visibility="public"
  16263. deprecated="not deprecated">
  16264. </constructor>
  16265. <constructor name="MRAdmin" type="org.apache.hadoop.conf.Configuration"
  16266. static="false" final="false" visibility="public"
  16267. deprecated="not deprecated">
  16268. </constructor>
  16269. <method name="run" return="int"
  16270. abstract="false" native="false" synchronized="false"
  16271. static="false" final="false" visibility="public"
  16272. deprecated="not deprecated">
  16273. <param name="args" type="java.lang.String[]"/>
  16274. <exception name="Exception" type="java.lang.Exception"/>
  16275. </method>
  16276. <method name="main"
  16277. abstract="false" native="false" synchronized="false"
  16278. static="true" final="false" visibility="public"
  16279. deprecated="not deprecated">
  16280. <param name="args" type="java.lang.String[]"/>
  16281. <exception name="Exception" type="java.lang.Exception"/>
  16282. </method>
  16283. <doc>
  16284. <![CDATA[Administrative access to Hadoop Map-Reduce.
  16285. Currently it only provides the ability to connect to the {@link JobTracker}
  16286. and refresh the service-level authorization policy.]]>
  16287. </doc>
  16288. </class>
  16289. <!-- end class org.apache.hadoop.mapred.tools.MRAdmin -->
  16290. </package>
  16291. <package name="org.apache.hadoop.mapreduce">
  16292. <!-- start class org.apache.hadoop.mapreduce.Counter -->
  16293. <class name="Counter" extends="java.lang.Object"
  16294. abstract="false"
  16295. static="false" final="false" visibility="public"
  16296. deprecated="not deprecated">
  16297. <implements name="org.apache.hadoop.io.Writable"/>
  16298. <constructor name="Counter"
  16299. static="false" final="false" visibility="protected"
  16300. deprecated="not deprecated">
  16301. </constructor>
  16302. <constructor name="Counter" type="java.lang.String, java.lang.String"
  16303. static="false" final="false" visibility="protected"
  16304. deprecated="not deprecated">
  16305. </constructor>
  16306. <method name="setDisplayName"
  16307. abstract="false" native="false" synchronized="true"
  16308. static="false" final="false" visibility="protected"
  16309. deprecated="not deprecated">
  16310. <param name="displayName" type="java.lang.String"/>
  16311. </method>
  16312. <method name="readFields"
  16313. abstract="false" native="false" synchronized="true"
  16314. static="false" final="false" visibility="public"
  16315. deprecated="not deprecated">
  16316. <param name="in" type="java.io.DataInput"/>
  16317. <exception name="IOException" type="java.io.IOException"/>
  16318. <doc>
  16319. <![CDATA[Read the binary representation of the counter]]>
  16320. </doc>
  16321. </method>
  16322. <method name="write"
  16323. abstract="false" native="false" synchronized="true"
  16324. static="false" final="false" visibility="public"
  16325. deprecated="not deprecated">
  16326. <param name="out" type="java.io.DataOutput"/>
  16327. <exception name="IOException" type="java.io.IOException"/>
  16328. <doc>
  16329. <![CDATA[Write the binary representation of the counter]]>
  16330. </doc>
  16331. </method>
  16332. <method name="getName" return="java.lang.String"
  16333. abstract="false" native="false" synchronized="true"
  16334. static="false" final="false" visibility="public"
  16335. deprecated="not deprecated">
  16336. </method>
  16337. <method name="getDisplayName" return="java.lang.String"
  16338. abstract="false" native="false" synchronized="true"
  16339. static="false" final="false" visibility="public"
  16340. deprecated="not deprecated">
  16341. <doc>
  16342. <![CDATA[Get the name of the counter.
  16343. @return the user facing name of the counter]]>
  16344. </doc>
  16345. </method>
  16346. <method name="getValue" return="long"
  16347. abstract="false" native="false" synchronized="true"
  16348. static="false" final="false" visibility="public"
  16349. deprecated="not deprecated">
  16350. <doc>
  16351. <![CDATA[What is the current value of this counter?
  16352. @return the current value]]>
  16353. </doc>
  16354. </method>
  16355. <method name="increment"
  16356. abstract="false" native="false" synchronized="true"
  16357. static="false" final="false" visibility="public"
  16358. deprecated="not deprecated">
  16359. <param name="incr" type="long"/>
  16360. <doc>
  16361. <![CDATA[Increment this counter by the given value
  16362. @param incr the value to increase this counter by]]>
  16363. </doc>
  16364. </method>
  16365. <method name="equals" return="boolean"
  16366. abstract="false" native="false" synchronized="true"
  16367. static="false" final="false" visibility="public"
  16368. deprecated="not deprecated">
  16369. <param name="genericRight" type="java.lang.Object"/>
  16370. </method>
  16371. <method name="hashCode" return="int"
  16372. abstract="false" native="false" synchronized="true"
  16373. static="false" final="false" visibility="public"
  16374. deprecated="not deprecated">
  16375. </method>
  16376. <doc>
  16377. <![CDATA[A named counter that tracks the progress of a map/reduce job.
  16378. <p><code>Counters</code> represent global counters, defined either by the
  16379. Map-Reduce framework or applications. Each <code>Counter</code> is named by
  16380. an {@link Enum} and has a long for the value.</p>
  16381. <p><code>Counters</code> are bunched into Groups, each comprising of
  16382. counters from a particular <code>Enum</code> class.]]>
  16383. </doc>
  16384. </class>
  16385. <!-- end class org.apache.hadoop.mapreduce.Counter -->
  16386. <!-- start class org.apache.hadoop.mapreduce.CounterGroup -->
  16387. <class name="CounterGroup" extends="java.lang.Object"
  16388. abstract="false"
  16389. static="false" final="false" visibility="public"
  16390. deprecated="not deprecated">
  16391. <implements name="org.apache.hadoop.io.Writable"/>
  16392. <implements name="java.lang.Iterable"/>
  16393. <constructor name="CounterGroup" type="java.lang.String"
  16394. static="false" final="false" visibility="protected"
  16395. deprecated="not deprecated">
  16396. </constructor>
  16397. <constructor name="CounterGroup" type="java.lang.String, java.lang.String"
  16398. static="false" final="false" visibility="protected"
  16399. deprecated="not deprecated">
  16400. </constructor>
  16401. <method name="getName" return="java.lang.String"
  16402. abstract="false" native="false" synchronized="true"
  16403. static="false" final="false" visibility="public"
  16404. deprecated="not deprecated">
  16405. <doc>
  16406. <![CDATA[Get the internal name of the group
  16407. @return the internal name]]>
  16408. </doc>
  16409. </method>
  16410. <method name="getDisplayName" return="java.lang.String"
  16411. abstract="false" native="false" synchronized="true"
  16412. static="false" final="false" visibility="public"
  16413. deprecated="not deprecated">
  16414. <doc>
  16415. <![CDATA[Get the display name of the group.
  16416. @return the human readable name]]>
  16417. </doc>
  16418. </method>
  16419. <method name="findCounter" return="org.apache.hadoop.mapreduce.Counter"
  16420. abstract="false" native="false" synchronized="false"
  16421. static="false" final="false" visibility="protected"
  16422. deprecated="not deprecated">
  16423. <param name="counterName" type="java.lang.String"/>
  16424. <param name="displayName" type="java.lang.String"/>
  16425. <doc>
  16426. <![CDATA[Internal to find a counter in a group.
  16427. @param counterName the name of the counter
  16428. @param displayName the display name of the counter
  16429. @return the counter that was found or added]]>
  16430. </doc>
  16431. </method>
  16432. <method name="findCounter" return="org.apache.hadoop.mapreduce.Counter"
  16433. abstract="false" native="false" synchronized="true"
  16434. static="false" final="false" visibility="public"
  16435. deprecated="not deprecated">
  16436. <param name="counterName" type="java.lang.String"/>
  16437. </method>
  16438. <method name="iterator" return="java.util.Iterator"
  16439. abstract="false" native="false" synchronized="true"
  16440. static="false" final="false" visibility="public"
  16441. deprecated="not deprecated">
  16442. </method>
  16443. <method name="write"
  16444. abstract="false" native="false" synchronized="true"
  16445. static="false" final="false" visibility="public"
  16446. deprecated="not deprecated">
  16447. <param name="out" type="java.io.DataOutput"/>
  16448. <exception name="IOException" type="java.io.IOException"/>
  16449. </method>
  16450. <method name="readFields"
  16451. abstract="false" native="false" synchronized="true"
  16452. static="false" final="false" visibility="public"
  16453. deprecated="not deprecated">
  16454. <param name="in" type="java.io.DataInput"/>
  16455. <exception name="IOException" type="java.io.IOException"/>
  16456. </method>
  16457. <method name="size" return="int"
  16458. abstract="false" native="false" synchronized="true"
  16459. static="false" final="false" visibility="public"
  16460. deprecated="not deprecated">
  16461. <doc>
  16462. <![CDATA[Returns the number of counters in this group.]]>
  16463. </doc>
  16464. </method>
  16465. <method name="equals" return="boolean"
  16466. abstract="false" native="false" synchronized="true"
  16467. static="false" final="false" visibility="public"
  16468. deprecated="not deprecated">
  16469. <param name="genericRight" type="java.lang.Object"/>
  16470. </method>
  16471. <method name="hashCode" return="int"
  16472. abstract="false" native="false" synchronized="true"
  16473. static="false" final="false" visibility="public"
  16474. deprecated="not deprecated">
  16475. </method>
  16476. <method name="incrAllCounters"
  16477. abstract="false" native="false" synchronized="true"
  16478. static="false" final="false" visibility="public"
  16479. deprecated="not deprecated">
  16480. <param name="rightGroup" type="org.apache.hadoop.mapreduce.CounterGroup"/>
  16481. </method>
  16482. <doc>
  16483. <![CDATA[A group of {@link Counter}s that logically belong together. Typically,
  16484. it is an {@link Enum} subclass and the counters are the values.]]>
  16485. </doc>
  16486. </class>
  16487. <!-- end class org.apache.hadoop.mapreduce.CounterGroup -->
  16488. <!-- start class org.apache.hadoop.mapreduce.Counters -->
  16489. <class name="Counters" extends="java.lang.Object"
  16490. abstract="false"
  16491. static="false" final="false" visibility="public"
  16492. deprecated="not deprecated">
  16493. <implements name="org.apache.hadoop.io.Writable"/>
  16494. <implements name="java.lang.Iterable"/>
  16495. <constructor name="Counters"
  16496. static="false" final="false" visibility="public"
  16497. deprecated="not deprecated">
  16498. </constructor>
  16499. <method name="findCounter" return="org.apache.hadoop.mapreduce.Counter"
  16500. abstract="false" native="false" synchronized="false"
  16501. static="false" final="false" visibility="public"
  16502. deprecated="not deprecated">
  16503. <param name="groupName" type="java.lang.String"/>
  16504. <param name="counterName" type="java.lang.String"/>
  16505. </method>
  16506. <method name="findCounter" return="org.apache.hadoop.mapreduce.Counter"
  16507. abstract="false" native="false" synchronized="true"
  16508. static="false" final="false" visibility="public"
  16509. deprecated="not deprecated">
  16510. <param name="key" type="java.lang.Enum"/>
  16511. <doc>
  16512. <![CDATA[Find the counter for the given enum. The same enum will always return the
  16513. same counter.
  16514. @param key the counter key
  16515. @return the matching counter object]]>
  16516. </doc>
  16517. </method>
  16518. <method name="getGroupNames" return="java.util.Collection"
  16519. abstract="false" native="false" synchronized="true"
  16520. static="false" final="false" visibility="public"
  16521. deprecated="not deprecated">
  16522. <doc>
  16523. <![CDATA[Returns the names of all counter classes.
  16524. @return Set of counter names.]]>
  16525. </doc>
  16526. </method>
  16527. <method name="iterator" return="java.util.Iterator"
  16528. abstract="false" native="false" synchronized="false"
  16529. static="false" final="false" visibility="public"
  16530. deprecated="not deprecated">
  16531. </method>
  16532. <method name="getGroup" return="org.apache.hadoop.mapreduce.CounterGroup"
  16533. abstract="false" native="false" synchronized="true"
  16534. static="false" final="false" visibility="public"
  16535. deprecated="not deprecated">
  16536. <param name="groupName" type="java.lang.String"/>
  16537. <doc>
  16538. <![CDATA[Returns the named counter group, or an empty group if there is none
  16539. with the specified name.]]>
  16540. </doc>
  16541. </method>
  16542. <method name="countCounters" return="int"
  16543. abstract="false" native="false" synchronized="true"
  16544. static="false" final="false" visibility="public"
  16545. deprecated="not deprecated">
  16546. <doc>
  16547. <![CDATA[Returns the total number of counters, by summing the number of counters
  16548. in each group.]]>
  16549. </doc>
  16550. </method>
  16551. <method name="write"
  16552. abstract="false" native="false" synchronized="true"
  16553. static="false" final="false" visibility="public"
  16554. deprecated="not deprecated">
  16555. <param name="out" type="java.io.DataOutput"/>
  16556. <exception name="IOException" type="java.io.IOException"/>
  16557. <doc>
  16558. <![CDATA[Write the set of groups.
  16559. The external format is:
  16560. #groups (groupName group)*
  16561. i.e. the number of groups followed by 0 or more groups, where each
  16562. group is of the form:
  16563. groupDisplayName #counters (false | true counter)*
  16564. where each counter is of the form:
  16565. name (false | true displayName) value]]>
  16566. </doc>
  16567. </method>
  16568. <method name="readFields"
  16569. abstract="false" native="false" synchronized="true"
  16570. static="false" final="false" visibility="public"
  16571. deprecated="not deprecated">
  16572. <param name="in" type="java.io.DataInput"/>
  16573. <exception name="IOException" type="java.io.IOException"/>
  16574. <doc>
  16575. <![CDATA[Read a set of groups.]]>
  16576. </doc>
  16577. </method>
  16578. <method name="toString" return="java.lang.String"
  16579. abstract="false" native="false" synchronized="true"
  16580. static="false" final="false" visibility="public"
  16581. deprecated="not deprecated">
  16582. <doc>
  16583. <![CDATA[Return textual representation of the counter values.]]>
  16584. </doc>
  16585. </method>
  16586. <method name="incrAllCounters"
  16587. abstract="false" native="false" synchronized="true"
  16588. static="false" final="false" visibility="public"
  16589. deprecated="not deprecated">
  16590. <param name="other" type="org.apache.hadoop.mapreduce.Counters"/>
  16591. <doc>
  16592. <![CDATA[Increments multiple counters by their amounts in another Counters
  16593. instance.
  16594. @param other the other Counters instance]]>
  16595. </doc>
  16596. </method>
  16597. <method name="equals" return="boolean"
  16598. abstract="false" native="false" synchronized="false"
  16599. static="false" final="false" visibility="public"
  16600. deprecated="not deprecated">
  16601. <param name="genericRight" type="java.lang.Object"/>
  16602. </method>
  16603. <method name="hashCode" return="int"
  16604. abstract="false" native="false" synchronized="false"
  16605. static="false" final="false" visibility="public"
  16606. deprecated="not deprecated">
  16607. </method>
  16608. </class>
  16609. <!-- end class org.apache.hadoop.mapreduce.Counters -->
  16610. <!-- start class org.apache.hadoop.mapreduce.ID -->
  16611. <class name="ID" extends="java.lang.Object"
  16612. abstract="true"
  16613. static="false" final="false" visibility="public"
  16614. deprecated="not deprecated">
  16615. <implements name="org.apache.hadoop.io.WritableComparable"/>
  16616. <constructor name="ID" type="int"
  16617. static="false" final="false" visibility="public"
  16618. deprecated="not deprecated">
  16619. <doc>
  16620. <![CDATA[constructs an ID object from the given int]]>
  16621. </doc>
  16622. </constructor>
  16623. <constructor name="ID"
  16624. static="false" final="false" visibility="protected"
  16625. deprecated="not deprecated">
  16626. </constructor>
  16627. <method name="getId" return="int"
  16628. abstract="false" native="false" synchronized="false"
  16629. static="false" final="false" visibility="public"
  16630. deprecated="not deprecated">
  16631. <doc>
  16632. <![CDATA[returns the int which represents the identifier]]>
  16633. </doc>
  16634. </method>
  16635. <method name="toString" return="java.lang.String"
  16636. abstract="false" native="false" synchronized="false"
  16637. static="false" final="false" visibility="public"
  16638. deprecated="not deprecated">
  16639. </method>
  16640. <method name="hashCode" return="int"
  16641. abstract="false" native="false" synchronized="false"
  16642. static="false" final="false" visibility="public"
  16643. deprecated="not deprecated">
  16644. </method>
  16645. <method name="equals" return="boolean"
  16646. abstract="false" native="false" synchronized="false"
  16647. static="false" final="false" visibility="public"
  16648. deprecated="not deprecated">
  16649. <param name="o" type="java.lang.Object"/>
  16650. </method>
  16651. <method name="compareTo" return="int"
  16652. abstract="false" native="false" synchronized="false"
  16653. static="false" final="false" visibility="public"
  16654. deprecated="not deprecated">
  16655. <param name="that" type="org.apache.hadoop.mapreduce.ID"/>
  16656. <doc>
  16657. <![CDATA[Compare IDs by associated numbers]]>
  16658. </doc>
  16659. </method>
  16660. <method name="readFields"
  16661. abstract="false" native="false" synchronized="false"
  16662. static="false" final="false" visibility="public"
  16663. deprecated="not deprecated">
  16664. <param name="in" type="java.io.DataInput"/>
  16665. <exception name="IOException" type="java.io.IOException"/>
  16666. </method>
  16667. <method name="write"
  16668. abstract="false" native="false" synchronized="false"
  16669. static="false" final="false" visibility="public"
  16670. deprecated="not deprecated">
  16671. <param name="out" type="java.io.DataOutput"/>
  16672. <exception name="IOException" type="java.io.IOException"/>
  16673. </method>
  16674. <field name="SEPARATOR" type="char"
  16675. transient="false" volatile="false"
  16676. static="true" final="true" visibility="protected"
  16677. deprecated="not deprecated">
  16678. </field>
  16679. <field name="id" type="int"
  16680. transient="false" volatile="false"
  16681. static="false" final="false" visibility="protected"
  16682. deprecated="not deprecated">
  16683. </field>
  16684. <doc>
  16685. <![CDATA[A general identifier, which internally stores the id
  16686. as an integer. This is the super class of {@link JobID},
  16687. {@link TaskID} and {@link TaskAttemptID}.
  16688. @see JobID
  16689. @see TaskID
  16690. @see TaskAttemptID]]>
  16691. </doc>
  16692. </class>
  16693. <!-- end class org.apache.hadoop.mapreduce.ID -->
  16694. <!-- start class org.apache.hadoop.mapreduce.InputFormat -->
  16695. <class name="InputFormat" extends="java.lang.Object"
  16696. abstract="true"
  16697. static="false" final="false" visibility="public"
  16698. deprecated="not deprecated">
  16699. <constructor name="InputFormat"
  16700. static="false" final="false" visibility="public"
  16701. deprecated="not deprecated">
  16702. </constructor>
  16703. <method name="getSplits" return="java.util.List"
  16704. abstract="true" native="false" synchronized="false"
  16705. static="false" final="false" visibility="public"
  16706. deprecated="not deprecated">
  16707. <param name="context" type="org.apache.hadoop.mapreduce.JobContext"/>
  16708. <exception name="IOException" type="java.io.IOException"/>
  16709. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  16710. <doc>
  16711. <![CDATA[Logically split the set of input files for the job.
  16712. <p>Each {@link InputSplit} is then assigned to an individual {@link Mapper}
  16713. for processing.</p>
  16714. <p><i>Note</i>: The split is a <i>logical</i> split of the inputs and the
  16715. input files are not physically split into chunks. For e.g. a split could
  16716. be <i>&lt;input-file-path, start, offset&gt;</i> tuple. The InputFormat
  16717. also creates the {@link RecordReader} to read the {@link InputSplit}.
  16718. @param context job configuration.
  16719. @return an array of {@link InputSplit}s for the job.]]>
  16720. </doc>
  16721. </method>
  16722. <method name="createRecordReader" return="org.apache.hadoop.mapreduce.RecordReader"
  16723. abstract="true" native="false" synchronized="false"
  16724. static="false" final="false" visibility="public"
  16725. deprecated="not deprecated">
  16726. <param name="split" type="org.apache.hadoop.mapreduce.InputSplit"/>
  16727. <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
  16728. <exception name="IOException" type="java.io.IOException"/>
  16729. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  16730. <doc>
  16731. <![CDATA[Create a record reader for a given split. The framework will call
  16732. {@link RecordReader#initialize(InputSplit, TaskAttemptContext)} before
  16733. the split is used.
  16734. @param split the split to be read
  16735. @param context the information about the task
  16736. @return a new record reader
  16737. @throws IOException
  16738. @throws InterruptedException]]>
  16739. </doc>
  16740. </method>
  16741. <doc>
  16742. <![CDATA[<code>InputFormat</code> describes the input-specification for a
  16743. Map-Reduce job.
  16744. <p>The Map-Reduce framework relies on the <code>InputFormat</code> of the
  16745. job to:<p>
  16746. <ol>
  16747. <li>
  16748. Validate the input-specification of the job.
  16749. <li>
  16750. Split-up the input file(s) into logical {@link InputSplit}s, each of
  16751. which is then assigned to an individual {@link Mapper}.
  16752. </li>
  16753. <li>
  16754. Provide the {@link RecordReader} implementation to be used to glean
  16755. input records from the logical <code>InputSplit</code> for processing by
  16756. the {@link Mapper}.
  16757. </li>
  16758. </ol>
  16759. <p>The default behavior of file-based {@link InputFormat}s, typically
  16760. sub-classes of {@link FileInputFormat}, is to split the
  16761. input into <i>logical</i> {@link InputSplit}s based on the total size, in
  16762. bytes, of the input files. However, the {@link FileSystem} blocksize of
  16763. the input files is treated as an upper bound for input splits. A lower bound
  16764. on the split size can be set via
  16765. <a href="{@docRoot}/../mapred-default.html#mapred.min.split.size">
  16766. mapred.min.split.size</a>.</p>
  16767. <p>Clearly, logical splits based on input-size is insufficient for many
  16768. applications since record boundaries are to respected. In such cases, the
  16769. application has to also implement a {@link RecordReader} on whom lies the
  16770. responsibility to respect record-boundaries and present a record-oriented
  16771. view of the logical <code>InputSplit</code> to the individual task.
  16772. @see InputSplit
  16773. @see RecordReader
  16774. @see FileInputFormat]]>
  16775. </doc>
  16776. </class>
  16777. <!-- end class org.apache.hadoop.mapreduce.InputFormat -->
  16778. <!-- start class org.apache.hadoop.mapreduce.InputSplit -->
  16779. <class name="InputSplit" extends="java.lang.Object"
  16780. abstract="true"
  16781. static="false" final="false" visibility="public"
  16782. deprecated="not deprecated">
  16783. <constructor name="InputSplit"
  16784. static="false" final="false" visibility="public"
  16785. deprecated="not deprecated">
  16786. </constructor>
  16787. <method name="getLength" return="long"
  16788. abstract="true" native="false" synchronized="false"
  16789. static="false" final="false" visibility="public"
  16790. deprecated="not deprecated">
  16791. <exception name="IOException" type="java.io.IOException"/>
  16792. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  16793. <doc>
  16794. <![CDATA[Get the size of the split, so that the input splits can be sorted by size.
  16795. @return the number of bytes in the split
  16796. @throws IOException
  16797. @throws InterruptedException]]>
  16798. </doc>
  16799. </method>
  16800. <method name="getLocations" return="java.lang.String[]"
  16801. abstract="true" native="false" synchronized="false"
  16802. static="false" final="false" visibility="public"
  16803. deprecated="not deprecated">
  16804. <exception name="IOException" type="java.io.IOException"/>
  16805. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  16806. <doc>
  16807. <![CDATA[Get the list of nodes by name where the data for the split would be local.
  16808. The locations do not need to be serialized.
  16809. @return a new array of the node nodes.
  16810. @throws IOException
  16811. @throws InterruptedException]]>
  16812. </doc>
  16813. </method>
  16814. <doc>
  16815. <![CDATA[<code>InputSplit</code> represents the data to be processed by an
  16816. individual {@link Mapper}.
  16817. <p>Typically, it presents a byte-oriented view on the input and is the
  16818. responsibility of {@link RecordReader} of the job to process this and present
  16819. a record-oriented view.
  16820. @see InputFormat
  16821. @see RecordReader]]>
  16822. </doc>
  16823. </class>
  16824. <!-- end class org.apache.hadoop.mapreduce.InputSplit -->
  16825. <!-- start class org.apache.hadoop.mapreduce.Job -->
  16826. <class name="Job" extends="org.apache.hadoop.mapreduce.JobContext"
  16827. abstract="false"
  16828. static="false" final="false" visibility="public"
  16829. deprecated="not deprecated">
  16830. <constructor name="Job"
  16831. static="false" final="false" visibility="public"
  16832. deprecated="not deprecated">
  16833. <exception name="IOException" type="java.io.IOException"/>
  16834. </constructor>
  16835. <constructor name="Job" type="org.apache.hadoop.conf.Configuration"
  16836. static="false" final="false" visibility="public"
  16837. deprecated="not deprecated">
  16838. <exception name="IOException" type="java.io.IOException"/>
  16839. </constructor>
  16840. <constructor name="Job" type="org.apache.hadoop.conf.Configuration, java.lang.String"
  16841. static="false" final="false" visibility="public"
  16842. deprecated="not deprecated">
  16843. <exception name="IOException" type="java.io.IOException"/>
  16844. </constructor>
  16845. <method name="setNumReduceTasks"
  16846. abstract="false" native="false" synchronized="false"
  16847. static="false" final="false" visibility="public"
  16848. deprecated="not deprecated">
  16849. <param name="tasks" type="int"/>
  16850. <exception name="IllegalStateException" type="java.lang.IllegalStateException"/>
  16851. <doc>
  16852. <![CDATA[Set the number of reduce tasks for the job.
  16853. @param tasks the number of reduce tasks
  16854. @throws IllegalStateException if the job is submitted]]>
  16855. </doc>
  16856. </method>
  16857. <method name="setWorkingDirectory"
  16858. abstract="false" native="false" synchronized="false"
  16859. static="false" final="false" visibility="public"
  16860. deprecated="not deprecated">
  16861. <param name="dir" type="org.apache.hadoop.fs.Path"/>
  16862. <exception name="IOException" type="java.io.IOException"/>
  16863. <doc>
  16864. <![CDATA[Set the current working directory for the default file system.
  16865. @param dir the new current working directory.
  16866. @throws IllegalStateException if the job is submitted]]>
  16867. </doc>
  16868. </method>
  16869. <method name="setInputFormatClass"
  16870. abstract="false" native="false" synchronized="false"
  16871. static="false" final="false" visibility="public"
  16872. deprecated="not deprecated">
  16873. <param name="cls" type="java.lang.Class"/>
  16874. <exception name="IllegalStateException" type="java.lang.IllegalStateException"/>
  16875. <doc>
  16876. <![CDATA[Set the {@link InputFormat} for the job.
  16877. @param cls the <code>InputFormat</code> to use
  16878. @throws IllegalStateException if the job is submitted]]>
  16879. </doc>
  16880. </method>
  16881. <method name="setOutputFormatClass"
  16882. abstract="false" native="false" synchronized="false"
  16883. static="false" final="false" visibility="public"
  16884. deprecated="not deprecated">
  16885. <param name="cls" type="java.lang.Class"/>
  16886. <exception name="IllegalStateException" type="java.lang.IllegalStateException"/>
  16887. <doc>
  16888. <![CDATA[Set the {@link OutputFormat} for the job.
  16889. @param cls the <code>OutputFormat</code> to use
  16890. @throws IllegalStateException if the job is submitted]]>
  16891. </doc>
  16892. </method>
  16893. <method name="setMapperClass"
  16894. abstract="false" native="false" synchronized="false"
  16895. static="false" final="false" visibility="public"
  16896. deprecated="not deprecated">
  16897. <param name="cls" type="java.lang.Class"/>
  16898. <exception name="IllegalStateException" type="java.lang.IllegalStateException"/>
  16899. <doc>
  16900. <![CDATA[Set the {@link Mapper} for the job.
  16901. @param cls the <code>Mapper</code> to use
  16902. @throws IllegalStateException if the job is submitted]]>
  16903. </doc>
  16904. </method>
  16905. <method name="setJarByClass"
  16906. abstract="false" native="false" synchronized="false"
  16907. static="false" final="false" visibility="public"
  16908. deprecated="not deprecated">
  16909. <param name="cls" type="java.lang.Class"/>
  16910. <doc>
  16911. <![CDATA[Set the Jar by finding where a given class came from.
  16912. @param cls the example class]]>
  16913. </doc>
  16914. </method>
  16915. <method name="getJar" return="java.lang.String"
  16916. abstract="false" native="false" synchronized="false"
  16917. static="false" final="false" visibility="public"
  16918. deprecated="not deprecated">
  16919. <doc>
  16920. <![CDATA[Get the pathname of the job's jar.
  16921. @return the pathname]]>
  16922. </doc>
  16923. </method>
  16924. <method name="setCombinerClass"
  16925. abstract="false" native="false" synchronized="false"
  16926. static="false" final="false" visibility="public"
  16927. deprecated="not deprecated">
  16928. <param name="cls" type="java.lang.Class"/>
  16929. <exception name="IllegalStateException" type="java.lang.IllegalStateException"/>
  16930. <doc>
  16931. <![CDATA[Set the combiner class for the job.
  16932. @param cls the combiner to use
  16933. @throws IllegalStateException if the job is submitted]]>
  16934. </doc>
  16935. </method>
  16936. <method name="setReducerClass"
  16937. abstract="false" native="false" synchronized="false"
  16938. static="false" final="false" visibility="public"
  16939. deprecated="not deprecated">
  16940. <param name="cls" type="java.lang.Class"/>
  16941. <exception name="IllegalStateException" type="java.lang.IllegalStateException"/>
  16942. <doc>
  16943. <![CDATA[Set the {@link Reducer} for the job.
  16944. @param cls the <code>Reducer</code> to use
  16945. @throws IllegalStateException if the job is submitted]]>
  16946. </doc>
  16947. </method>
  16948. <method name="setPartitionerClass"
  16949. abstract="false" native="false" synchronized="false"
  16950. static="false" final="false" visibility="public"
  16951. deprecated="not deprecated">
  16952. <param name="cls" type="java.lang.Class"/>
  16953. <exception name="IllegalStateException" type="java.lang.IllegalStateException"/>
  16954. <doc>
  16955. <![CDATA[Set the {@link Partitioner} for the job.
  16956. @param cls the <code>Partitioner</code> to use
  16957. @throws IllegalStateException if the job is submitted]]>
  16958. </doc>
  16959. </method>
  16960. <method name="setMapOutputKeyClass"
  16961. abstract="false" native="false" synchronized="false"
  16962. static="false" final="false" visibility="public"
  16963. deprecated="not deprecated">
  16964. <param name="theClass" type="java.lang.Class"/>
  16965. <exception name="IllegalStateException" type="java.lang.IllegalStateException"/>
  16966. <doc>
  16967. <![CDATA[Set the key class for the map output data. This allows the user to
  16968. specify the map output key class to be different than the final output
  16969. value class.
  16970. @param theClass the map output key class.
  16971. @throws IllegalStateException if the job is submitted]]>
  16972. </doc>
  16973. </method>
  16974. <method name="setMapOutputValueClass"
  16975. abstract="false" native="false" synchronized="false"
  16976. static="false" final="false" visibility="public"
  16977. deprecated="not deprecated">
  16978. <param name="theClass" type="java.lang.Class"/>
  16979. <exception name="IllegalStateException" type="java.lang.IllegalStateException"/>
  16980. <doc>
  16981. <![CDATA[Set the value class for the map output data. This allows the user to
  16982. specify the map output value class to be different than the final output
  16983. value class.
  16984. @param theClass the map output value class.
  16985. @throws IllegalStateException if the job is submitted]]>
  16986. </doc>
  16987. </method>
  16988. <method name="setOutputKeyClass"
  16989. abstract="false" native="false" synchronized="false"
  16990. static="false" final="false" visibility="public"
  16991. deprecated="not deprecated">
  16992. <param name="theClass" type="java.lang.Class"/>
  16993. <exception name="IllegalStateException" type="java.lang.IllegalStateException"/>
  16994. <doc>
  16995. <![CDATA[Set the key class for the job output data.
  16996. @param theClass the key class for the job output data.
  16997. @throws IllegalStateException if the job is submitted]]>
  16998. </doc>
  16999. </method>
  17000. <method name="setOutputValueClass"
  17001. abstract="false" native="false" synchronized="false"
  17002. static="false" final="false" visibility="public"
  17003. deprecated="not deprecated">
  17004. <param name="theClass" type="java.lang.Class"/>
  17005. <exception name="IllegalStateException" type="java.lang.IllegalStateException"/>
  17006. <doc>
  17007. <![CDATA[Set the value class for job outputs.
  17008. @param theClass the value class for job outputs.
  17009. @throws IllegalStateException if the job is submitted]]>
  17010. </doc>
  17011. </method>
  17012. <method name="setSortComparatorClass"
  17013. abstract="false" native="false" synchronized="false"
  17014. static="false" final="false" visibility="public"
  17015. deprecated="not deprecated">
  17016. <param name="cls" type="java.lang.Class"/>
  17017. <exception name="IllegalStateException" type="java.lang.IllegalStateException"/>
  17018. <doc>
  17019. <![CDATA[Define the comparator that controls how the keys are sorted before they
  17020. are passed to the {@link Reducer}.
  17021. @param cls the raw comparator
  17022. @throws IllegalStateException if the job is submitted]]>
  17023. </doc>
  17024. </method>
  17025. <method name="setGroupingComparatorClass"
  17026. abstract="false" native="false" synchronized="false"
  17027. static="false" final="false" visibility="public"
  17028. deprecated="not deprecated">
  17029. <param name="cls" type="java.lang.Class"/>
  17030. <exception name="IllegalStateException" type="java.lang.IllegalStateException"/>
  17031. <doc>
  17032. <![CDATA[Define the comparator that controls which keys are grouped together
  17033. for a single call to
  17034. {@link Reducer#reduce(Object, Iterable,
  17035. org.apache.hadoop.mapreduce.Reducer.Context)}
  17036. @param cls the raw comparator to use
  17037. @throws IllegalStateException if the job is submitted]]>
  17038. </doc>
  17039. </method>
  17040. <method name="setJobName"
  17041. abstract="false" native="false" synchronized="false"
  17042. static="false" final="false" visibility="public"
  17043. deprecated="not deprecated">
  17044. <param name="name" type="java.lang.String"/>
  17045. <exception name="IllegalStateException" type="java.lang.IllegalStateException"/>
  17046. <doc>
  17047. <![CDATA[Set the user-specified job name.
  17048. @param name the job's new name.
  17049. @throws IllegalStateException if the job is submitted]]>
  17050. </doc>
  17051. </method>
  17052. <method name="getTrackingURL" return="java.lang.String"
  17053. abstract="false" native="false" synchronized="false"
  17054. static="false" final="false" visibility="public"
  17055. deprecated="not deprecated">
  17056. <doc>
  17057. <![CDATA[Get the URL where some job progress information will be displayed.
  17058. @return the URL where some job progress information will be displayed.]]>
  17059. </doc>
  17060. </method>
  17061. <method name="mapProgress" return="float"
  17062. abstract="false" native="false" synchronized="false"
  17063. static="false" final="false" visibility="public"
  17064. deprecated="not deprecated">
  17065. <exception name="IOException" type="java.io.IOException"/>
  17066. <doc>
  17067. <![CDATA[Get the <i>progress</i> of the job's map-tasks, as a float between 0.0
  17068. and 1.0. When all map tasks have completed, the function returns 1.0.
  17069. @return the progress of the job's map-tasks.
  17070. @throws IOException]]>
  17071. </doc>
  17072. </method>
  17073. <method name="reduceProgress" return="float"
  17074. abstract="false" native="false" synchronized="false"
  17075. static="false" final="false" visibility="public"
  17076. deprecated="not deprecated">
  17077. <exception name="IOException" type="java.io.IOException"/>
  17078. <doc>
  17079. <![CDATA[Get the <i>progress</i> of the job's reduce-tasks, as a float between 0.0
  17080. and 1.0. When all reduce tasks have completed, the function returns 1.0.
  17081. @return the progress of the job's reduce-tasks.
  17082. @throws IOException]]>
  17083. </doc>
  17084. </method>
  17085. <method name="isComplete" return="boolean"
  17086. abstract="false" native="false" synchronized="false"
  17087. static="false" final="false" visibility="public"
  17088. deprecated="not deprecated">
  17089. <exception name="IOException" type="java.io.IOException"/>
  17090. <doc>
  17091. <![CDATA[Check if the job is finished or not.
  17092. This is a non-blocking call.
  17093. @return <code>true</code> if the job is complete, else <code>false</code>.
  17094. @throws IOException]]>
  17095. </doc>
  17096. </method>
  17097. <method name="isSuccessful" return="boolean"
  17098. abstract="false" native="false" synchronized="false"
  17099. static="false" final="false" visibility="public"
  17100. deprecated="not deprecated">
  17101. <exception name="IOException" type="java.io.IOException"/>
  17102. <doc>
  17103. <![CDATA[Check if the job completed successfully.
  17104. @return <code>true</code> if the job succeeded, else <code>false</code>.
  17105. @throws IOException]]>
  17106. </doc>
  17107. </method>
  17108. <method name="killJob"
  17109. abstract="false" native="false" synchronized="false"
  17110. static="false" final="false" visibility="public"
  17111. deprecated="not deprecated">
  17112. <exception name="IOException" type="java.io.IOException"/>
  17113. <doc>
  17114. <![CDATA[Kill the running job. Blocks until all job tasks have been
  17115. killed as well. If the job is no longer running, it simply returns.
  17116. @throws IOException]]>
  17117. </doc>
  17118. </method>
  17119. <method name="getTaskCompletionEvents" return="org.apache.hadoop.mapred.TaskCompletionEvent[]"
  17120. abstract="false" native="false" synchronized="false"
  17121. static="false" final="false" visibility="public"
  17122. deprecated="not deprecated">
  17123. <param name="startFrom" type="int"/>
  17124. <exception name="IOException" type="java.io.IOException"/>
  17125. <doc>
  17126. <![CDATA[Get events indicating completion (success/failure) of component tasks.
  17127. @param startFrom index to start fetching events from
  17128. @return an array of {@link TaskCompletionEvent}s
  17129. @throws IOException]]>
  17130. </doc>
  17131. </method>
  17132. <method name="killTask"
  17133. abstract="false" native="false" synchronized="false"
  17134. static="false" final="false" visibility="public"
  17135. deprecated="not deprecated">
  17136. <param name="taskId" type="org.apache.hadoop.mapreduce.TaskAttemptID"/>
  17137. <exception name="IOException" type="java.io.IOException"/>
  17138. <doc>
  17139. <![CDATA[Kill indicated task attempt.
  17140. @param taskId the id of the task to be terminated.
  17141. @throws IOException]]>
  17142. </doc>
  17143. </method>
  17144. <method name="failTask"
  17145. abstract="false" native="false" synchronized="false"
  17146. static="false" final="false" visibility="public"
  17147. deprecated="not deprecated">
  17148. <param name="taskId" type="org.apache.hadoop.mapreduce.TaskAttemptID"/>
  17149. <exception name="IOException" type="java.io.IOException"/>
  17150. <doc>
  17151. <![CDATA[Fail indicated task attempt.
  17152. @param taskId the id of the task to be terminated.
  17153. @throws IOException]]>
  17154. </doc>
  17155. </method>
  17156. <method name="getCounters" return="org.apache.hadoop.mapreduce.Counters"
  17157. abstract="false" native="false" synchronized="false"
  17158. static="false" final="false" visibility="public"
  17159. deprecated="not deprecated">
  17160. <exception name="IOException" type="java.io.IOException"/>
  17161. <doc>
  17162. <![CDATA[Gets the counters for this job.
  17163. @return the counters for this job.
  17164. @throws IOException]]>
  17165. </doc>
  17166. </method>
  17167. <method name="submit"
  17168. abstract="false" native="false" synchronized="false"
  17169. static="false" final="false" visibility="public"
  17170. deprecated="not deprecated">
  17171. <exception name="IOException" type="java.io.IOException"/>
  17172. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  17173. <exception name="ClassNotFoundException" type="java.lang.ClassNotFoundException"/>
  17174. <doc>
  17175. <![CDATA[Submit the job to the cluster and return immediately.
  17176. @throws IOException]]>
  17177. </doc>
  17178. </method>
  17179. <method name="waitForCompletion" return="boolean"
  17180. abstract="false" native="false" synchronized="false"
  17181. static="false" final="false" visibility="public"
  17182. deprecated="not deprecated">
  17183. <param name="verbose" type="boolean"/>
  17184. <exception name="IOException" type="java.io.IOException"/>
  17185. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  17186. <exception name="ClassNotFoundException" type="java.lang.ClassNotFoundException"/>
  17187. <doc>
  17188. <![CDATA[Submit the job to the cluster and wait for it to finish.
  17189. @param verbose print the progress to the user
  17190. @return true if the job succeeded
  17191. @throws IOException thrown if the communication with the
  17192. <code>JobTracker</code> is lost]]>
  17193. </doc>
  17194. </method>
  17195. <doc>
  17196. <![CDATA[The job submitter's view of the Job. It allows the user to configure the
  17197. job, submit it, control its execution, and query the state. The set methods
  17198. only work until the job is submitted, afterwards they will throw an
  17199. IllegalStateException.]]>
  17200. </doc>
  17201. </class>
  17202. <!-- end class org.apache.hadoop.mapreduce.Job -->
  17203. <!-- start class org.apache.hadoop.mapreduce.Job.JobState -->
  17204. <class name="Job.JobState" extends="java.lang.Enum"
  17205. abstract="false"
  17206. static="true" final="true" visibility="public"
  17207. deprecated="not deprecated">
  17208. <method name="values" return="org.apache.hadoop.mapreduce.Job.JobState[]"
  17209. abstract="false" native="false" synchronized="false"
  17210. static="true" final="false" visibility="public"
  17211. deprecated="not deprecated">
  17212. </method>
  17213. <method name="valueOf" return="org.apache.hadoop.mapreduce.Job.JobState"
  17214. abstract="false" native="false" synchronized="false"
  17215. static="true" final="false" visibility="public"
  17216. deprecated="not deprecated">
  17217. <param name="name" type="java.lang.String"/>
  17218. </method>
  17219. <field name="DEFINE" type="org.apache.hadoop.mapreduce.Job.JobState"
  17220. transient="false" volatile="false"
  17221. static="true" final="true" visibility="public"
  17222. deprecated="not deprecated">
  17223. </field>
  17224. <field name="RUNNING" type="org.apache.hadoop.mapreduce.Job.JobState"
  17225. transient="false" volatile="false"
  17226. static="true" final="true" visibility="public"
  17227. deprecated="not deprecated">
  17228. </field>
  17229. </class>
  17230. <!-- end class org.apache.hadoop.mapreduce.Job.JobState -->
  17231. <!-- start class org.apache.hadoop.mapreduce.JobContext -->
  17232. <class name="JobContext" extends="java.lang.Object"
  17233. abstract="false"
  17234. static="false" final="false" visibility="public"
  17235. deprecated="not deprecated">
  17236. <constructor name="JobContext" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.mapreduce.JobID"
  17237. static="false" final="false" visibility="public"
  17238. deprecated="not deprecated">
  17239. </constructor>
  17240. <method name="getConfiguration" return="org.apache.hadoop.conf.Configuration"
  17241. abstract="false" native="false" synchronized="false"
  17242. static="false" final="false" visibility="public"
  17243. deprecated="not deprecated">
  17244. <doc>
  17245. <![CDATA[Return the configuration for the job.
  17246. @return the shared configuration object]]>
  17247. </doc>
  17248. </method>
  17249. <method name="getJobID" return="org.apache.hadoop.mapreduce.JobID"
  17250. abstract="false" native="false" synchronized="false"
  17251. static="false" final="false" visibility="public"
  17252. deprecated="not deprecated">
  17253. <doc>
  17254. <![CDATA[Get the unique ID for the job.
  17255. @return the object with the job id]]>
  17256. </doc>
  17257. </method>
  17258. <method name="getNumReduceTasks" return="int"
  17259. abstract="false" native="false" synchronized="false"
  17260. static="false" final="false" visibility="public"
  17261. deprecated="not deprecated">
  17262. <doc>
  17263. <![CDATA[Get configured the number of reduce tasks for this job. Defaults to
  17264. <code>1</code>.
  17265. @return the number of reduce tasks for this job.]]>
  17266. </doc>
  17267. </method>
  17268. <method name="getWorkingDirectory" return="org.apache.hadoop.fs.Path"
  17269. abstract="false" native="false" synchronized="false"
  17270. static="false" final="false" visibility="public"
  17271. deprecated="not deprecated">
  17272. <exception name="IOException" type="java.io.IOException"/>
  17273. <doc>
  17274. <![CDATA[Get the current working directory for the default file system.
  17275. @return the directory name.]]>
  17276. </doc>
  17277. </method>
  17278. <method name="getOutputKeyClass" return="java.lang.Class"
  17279. abstract="false" native="false" synchronized="false"
  17280. static="false" final="false" visibility="public"
  17281. deprecated="not deprecated">
  17282. <doc>
  17283. <![CDATA[Get the key class for the job output data.
  17284. @return the key class for the job output data.]]>
  17285. </doc>
  17286. </method>
  17287. <method name="getOutputValueClass" return="java.lang.Class"
  17288. abstract="false" native="false" synchronized="false"
  17289. static="false" final="false" visibility="public"
  17290. deprecated="not deprecated">
  17291. <doc>
  17292. <![CDATA[Get the value class for job outputs.
  17293. @return the value class for job outputs.]]>
  17294. </doc>
  17295. </method>
  17296. <method name="getMapOutputKeyClass" return="java.lang.Class"
  17297. abstract="false" native="false" synchronized="false"
  17298. static="false" final="false" visibility="public"
  17299. deprecated="not deprecated">
  17300. <doc>
  17301. <![CDATA[Get the key class for the map output data. If it is not set, use the
  17302. (final) output key class. This allows the map output key class to be
  17303. different than the final output key class.
  17304. @return the map output key class.]]>
  17305. </doc>
  17306. </method>
  17307. <method name="getMapOutputValueClass" return="java.lang.Class"
  17308. abstract="false" native="false" synchronized="false"
  17309. static="false" final="false" visibility="public"
  17310. deprecated="not deprecated">
  17311. <doc>
  17312. <![CDATA[Get the value class for the map output data. If it is not set, use the
  17313. (final) output value class This allows the map output value class to be
  17314. different than the final output value class.
  17315. @return the map output value class.]]>
  17316. </doc>
  17317. </method>
  17318. <method name="getJobName" return="java.lang.String"
  17319. abstract="false" native="false" synchronized="false"
  17320. static="false" final="false" visibility="public"
  17321. deprecated="not deprecated">
  17322. <doc>
  17323. <![CDATA[Get the user-specified job name. This is only used to identify the
  17324. job to the user.
  17325. @return the job's name, defaulting to "".]]>
  17326. </doc>
  17327. </method>
  17328. <method name="getInputFormatClass" return="java.lang.Class"
  17329. abstract="false" native="false" synchronized="false"
  17330. static="false" final="false" visibility="public"
  17331. deprecated="not deprecated">
  17332. <exception name="ClassNotFoundException" type="java.lang.ClassNotFoundException"/>
  17333. <doc>
  17334. <![CDATA[Get the {@link InputFormat} class for the job.
  17335. @return the {@link InputFormat} class for the job.]]>
  17336. </doc>
  17337. </method>
  17338. <method name="getMapperClass" return="java.lang.Class"
  17339. abstract="false" native="false" synchronized="false"
  17340. static="false" final="false" visibility="public"
  17341. deprecated="not deprecated">
  17342. <exception name="ClassNotFoundException" type="java.lang.ClassNotFoundException"/>
  17343. <doc>
  17344. <![CDATA[Get the {@link Mapper} class for the job.
  17345. @return the {@link Mapper} class for the job.]]>
  17346. </doc>
  17347. </method>
  17348. <method name="getCombinerClass" return="java.lang.Class"
  17349. abstract="false" native="false" synchronized="false"
  17350. static="false" final="false" visibility="public"
  17351. deprecated="not deprecated">
  17352. <exception name="ClassNotFoundException" type="java.lang.ClassNotFoundException"/>
  17353. <doc>
  17354. <![CDATA[Get the combiner class for the job.
  17355. @return the combiner class for the job.]]>
  17356. </doc>
  17357. </method>
  17358. <method name="getReducerClass" return="java.lang.Class"
  17359. abstract="false" native="false" synchronized="false"
  17360. static="false" final="false" visibility="public"
  17361. deprecated="not deprecated">
  17362. <exception name="ClassNotFoundException" type="java.lang.ClassNotFoundException"/>
  17363. <doc>
  17364. <![CDATA[Get the {@link Reducer} class for the job.
  17365. @return the {@link Reducer} class for the job.]]>
  17366. </doc>
  17367. </method>
  17368. <method name="getOutputFormatClass" return="java.lang.Class"
  17369. abstract="false" native="false" synchronized="false"
  17370. static="false" final="false" visibility="public"
  17371. deprecated="not deprecated">
  17372. <exception name="ClassNotFoundException" type="java.lang.ClassNotFoundException"/>
  17373. <doc>
  17374. <![CDATA[Get the {@link OutputFormat} class for the job.
  17375. @return the {@link OutputFormat} class for the job.]]>
  17376. </doc>
  17377. </method>
  17378. <method name="getPartitionerClass" return="java.lang.Class"
  17379. abstract="false" native="false" synchronized="false"
  17380. static="false" final="false" visibility="public"
  17381. deprecated="not deprecated">
  17382. <exception name="ClassNotFoundException" type="java.lang.ClassNotFoundException"/>
  17383. <doc>
  17384. <![CDATA[Get the {@link Partitioner} class for the job.
  17385. @return the {@link Partitioner} class for the job.]]>
  17386. </doc>
  17387. </method>
  17388. <method name="getSortComparator" return="org.apache.hadoop.io.RawComparator"
  17389. abstract="false" native="false" synchronized="false"
  17390. static="false" final="false" visibility="public"
  17391. deprecated="not deprecated">
  17392. <doc>
  17393. <![CDATA[Get the {@link RawComparator} comparator used to compare keys.
  17394. @return the {@link RawComparator} comparator used to compare keys.]]>
  17395. </doc>
  17396. </method>
  17397. <method name="getJar" return="java.lang.String"
  17398. abstract="false" native="false" synchronized="false"
  17399. static="false" final="false" visibility="public"
  17400. deprecated="not deprecated">
  17401. <doc>
  17402. <![CDATA[Get the pathname of the job's jar.
  17403. @return the pathname]]>
  17404. </doc>
  17405. </method>
  17406. <method name="getGroupingComparator" return="org.apache.hadoop.io.RawComparator"
  17407. abstract="false" native="false" synchronized="false"
  17408. static="false" final="false" visibility="public"
  17409. deprecated="not deprecated">
  17410. <doc>
  17411. <![CDATA[Get the user defined {@link RawComparator} comparator for
  17412. grouping keys of inputs to the reduce.
  17413. @return comparator set by the user for grouping values.
  17414. @see Job#setGroupingComparatorClass(Class) for details.]]>
  17415. </doc>
  17416. </method>
  17417. <field name="INPUT_FORMAT_CLASS_ATTR" type="java.lang.String"
  17418. transient="false" volatile="false"
  17419. static="true" final="true" visibility="protected"
  17420. deprecated="not deprecated">
  17421. </field>
  17422. <field name="MAP_CLASS_ATTR" type="java.lang.String"
  17423. transient="false" volatile="false"
  17424. static="true" final="true" visibility="protected"
  17425. deprecated="not deprecated">
  17426. </field>
  17427. <field name="COMBINE_CLASS_ATTR" type="java.lang.String"
  17428. transient="false" volatile="false"
  17429. static="true" final="true" visibility="protected"
  17430. deprecated="not deprecated">
  17431. </field>
  17432. <field name="REDUCE_CLASS_ATTR" type="java.lang.String"
  17433. transient="false" volatile="false"
  17434. static="true" final="true" visibility="protected"
  17435. deprecated="not deprecated">
  17436. </field>
  17437. <field name="OUTPUT_FORMAT_CLASS_ATTR" type="java.lang.String"
  17438. transient="false" volatile="false"
  17439. static="true" final="true" visibility="protected"
  17440. deprecated="not deprecated">
  17441. </field>
  17442. <field name="PARTITIONER_CLASS_ATTR" type="java.lang.String"
  17443. transient="false" volatile="false"
  17444. static="true" final="true" visibility="protected"
  17445. deprecated="not deprecated">
  17446. </field>
  17447. <field name="conf" type="org.apache.hadoop.mapred.JobConf"
  17448. transient="false" volatile="false"
  17449. static="false" final="true" visibility="protected"
  17450. deprecated="not deprecated">
  17451. </field>
  17452. <doc>
  17453. <![CDATA[A read-only view of the job that is provided to the tasks while they
  17454. are running.]]>
  17455. </doc>
  17456. </class>
  17457. <!-- end class org.apache.hadoop.mapreduce.JobContext -->
  17458. <!-- start class org.apache.hadoop.mapreduce.JobID -->
  17459. <class name="JobID" extends="org.apache.hadoop.mapred.ID"
  17460. abstract="false"
  17461. static="false" final="false" visibility="public"
  17462. deprecated="not deprecated">
  17463. <implements name="java.lang.Comparable"/>
  17464. <constructor name="JobID" type="java.lang.String, int"
  17465. static="false" final="false" visibility="public"
  17466. deprecated="not deprecated">
  17467. <doc>
  17468. <![CDATA[Constructs a JobID object
  17469. @param jtIdentifier jobTracker identifier
  17470. @param id job number]]>
  17471. </doc>
  17472. </constructor>
  17473. <constructor name="JobID"
  17474. static="false" final="false" visibility="public"
  17475. deprecated="not deprecated">
  17476. </constructor>
  17477. <method name="getJtIdentifier" return="java.lang.String"
  17478. abstract="false" native="false" synchronized="false"
  17479. static="false" final="false" visibility="public"
  17480. deprecated="not deprecated">
  17481. </method>
  17482. <method name="equals" return="boolean"
  17483. abstract="false" native="false" synchronized="false"
  17484. static="false" final="false" visibility="public"
  17485. deprecated="not deprecated">
  17486. <param name="o" type="java.lang.Object"/>
  17487. </method>
  17488. <method name="compareTo" return="int"
  17489. abstract="false" native="false" synchronized="false"
  17490. static="false" final="false" visibility="public"
  17491. deprecated="not deprecated">
  17492. <param name="o" type="org.apache.hadoop.mapreduce.ID"/>
  17493. <doc>
  17494. <![CDATA[Compare JobIds by first jtIdentifiers, then by job numbers]]>
  17495. </doc>
  17496. </method>
  17497. <method name="appendTo" return="java.lang.StringBuilder"
  17498. abstract="false" native="false" synchronized="false"
  17499. static="false" final="false" visibility="public"
  17500. deprecated="not deprecated">
  17501. <param name="builder" type="java.lang.StringBuilder"/>
  17502. <doc>
  17503. <![CDATA[Add the stuff after the "job" prefix to the given builder. This is useful,
  17504. because the sub-ids use this substring at the start of their string.
  17505. @param builder the builder to append to
  17506. @return the builder that was passed in]]>
  17507. </doc>
  17508. </method>
  17509. <method name="hashCode" return="int"
  17510. abstract="false" native="false" synchronized="false"
  17511. static="false" final="false" visibility="public"
  17512. deprecated="not deprecated">
  17513. </method>
  17514. <method name="toString" return="java.lang.String"
  17515. abstract="false" native="false" synchronized="false"
  17516. static="false" final="false" visibility="public"
  17517. deprecated="not deprecated">
  17518. </method>
  17519. <method name="readFields"
  17520. abstract="false" native="false" synchronized="false"
  17521. static="false" final="false" visibility="public"
  17522. deprecated="not deprecated">
  17523. <param name="in" type="java.io.DataInput"/>
  17524. <exception name="IOException" type="java.io.IOException"/>
  17525. </method>
  17526. <method name="write"
  17527. abstract="false" native="false" synchronized="false"
  17528. static="false" final="false" visibility="public"
  17529. deprecated="not deprecated">
  17530. <param name="out" type="java.io.DataOutput"/>
  17531. <exception name="IOException" type="java.io.IOException"/>
  17532. </method>
  17533. <method name="forName" return="org.apache.hadoop.mapreduce.JobID"
  17534. abstract="false" native="false" synchronized="false"
  17535. static="true" final="false" visibility="public"
  17536. deprecated="not deprecated">
  17537. <param name="str" type="java.lang.String"/>
  17538. <exception name="IllegalArgumentException" type="java.lang.IllegalArgumentException"/>
  17539. <doc>
  17540. <![CDATA[Construct a JobId object from given string
  17541. @return constructed JobId object or null if the given String is null
  17542. @throws IllegalArgumentException if the given string is malformed]]>
  17543. </doc>
  17544. </method>
  17545. <field name="JOB" type="java.lang.String"
  17546. transient="false" volatile="false"
  17547. static="true" final="true" visibility="protected"
  17548. deprecated="not deprecated">
  17549. </field>
  17550. <field name="idFormat" type="java.text.NumberFormat"
  17551. transient="false" volatile="false"
  17552. static="true" final="true" visibility="protected"
  17553. deprecated="not deprecated">
  17554. </field>
  17555. <doc>
  17556. <![CDATA[JobID represents the immutable and unique identifier for
  17557. the job. JobID consists of two parts. First part
  17558. represents the jobtracker identifier, so that jobID to jobtracker map
  17559. is defined. For cluster setup this string is the jobtracker
  17560. start time, for local setting, it is "local".
  17561. Second part of the JobID is the job number. <br>
  17562. An example JobID is :
  17563. <code>job_200707121733_0003</code> , which represents the third job
  17564. running at the jobtracker started at <code>200707121733</code>.
  17565. <p>
  17566. Applications should never construct or parse JobID strings, but rather
  17567. use appropriate constructors or {@link #forName(String)} method.
  17568. @see TaskID
  17569. @see TaskAttemptID
  17570. @see org.apache.hadoop.mapred.JobTracker#getNewJobId()
  17571. @see org.apache.hadoop.mapred.JobTracker#getStartTime()]]>
  17572. </doc>
  17573. </class>
  17574. <!-- end class org.apache.hadoop.mapreduce.JobID -->
  17575. <!-- start class org.apache.hadoop.mapreduce.MapContext -->
  17576. <class name="MapContext" extends="org.apache.hadoop.mapreduce.TaskInputOutputContext"
  17577. abstract="false"
  17578. static="false" final="false" visibility="public"
  17579. deprecated="not deprecated">
  17580. <constructor name="MapContext" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.mapreduce.TaskAttemptID, org.apache.hadoop.mapreduce.RecordReader, org.apache.hadoop.mapreduce.RecordWriter, org.apache.hadoop.mapreduce.OutputCommitter, org.apache.hadoop.mapreduce.StatusReporter, org.apache.hadoop.mapreduce.InputSplit"
  17581. static="false" final="false" visibility="public"
  17582. deprecated="not deprecated">
  17583. </constructor>
  17584. <method name="getInputSplit" return="org.apache.hadoop.mapreduce.InputSplit"
  17585. abstract="false" native="false" synchronized="false"
  17586. static="false" final="false" visibility="public"
  17587. deprecated="not deprecated">
  17588. <doc>
  17589. <![CDATA[Get the input split for this map.]]>
  17590. </doc>
  17591. </method>
  17592. <method name="getCurrentKey" return="java.lang.Object"
  17593. abstract="false" native="false" synchronized="false"
  17594. static="false" final="false" visibility="public"
  17595. deprecated="not deprecated">
  17596. <exception name="IOException" type="java.io.IOException"/>
  17597. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  17598. </method>
  17599. <method name="getCurrentValue" return="java.lang.Object"
  17600. abstract="false" native="false" synchronized="false"
  17601. static="false" final="false" visibility="public"
  17602. deprecated="not deprecated">
  17603. <exception name="IOException" type="java.io.IOException"/>
  17604. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  17605. </method>
  17606. <method name="nextKeyValue" return="boolean"
  17607. abstract="false" native="false" synchronized="false"
  17608. static="false" final="false" visibility="public"
  17609. deprecated="not deprecated">
  17610. <exception name="IOException" type="java.io.IOException"/>
  17611. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  17612. </method>
  17613. <doc>
  17614. <![CDATA[The context that is given to the {@link Mapper}.
  17615. @param <KEYIN> the key input type to the Mapper
  17616. @param <VALUEIN> the value input type to the Mapper
  17617. @param <KEYOUT> the key output type from the Mapper
  17618. @param <VALUEOUT> the value output type from the Mapper]]>
  17619. </doc>
  17620. </class>
  17621. <!-- end class org.apache.hadoop.mapreduce.MapContext -->
  17622. <!-- start class org.apache.hadoop.mapreduce.Mapper -->
  17623. <class name="Mapper" extends="java.lang.Object"
  17624. abstract="false"
  17625. static="false" final="false" visibility="public"
  17626. deprecated="not deprecated">
  17627. <constructor name="Mapper"
  17628. static="false" final="false" visibility="public"
  17629. deprecated="not deprecated">
  17630. </constructor>
  17631. <method name="setup"
  17632. abstract="false" native="false" synchronized="false"
  17633. static="false" final="false" visibility="protected"
  17634. deprecated="not deprecated">
  17635. <param name="context" type="org.apache.hadoop.mapreduce.Mapper.Context"/>
  17636. <exception name="IOException" type="java.io.IOException"/>
  17637. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  17638. <doc>
  17639. <![CDATA[Called once at the beginning of the task.]]>
  17640. </doc>
  17641. </method>
  17642. <method name="map"
  17643. abstract="false" native="false" synchronized="false"
  17644. static="false" final="false" visibility="protected"
  17645. deprecated="not deprecated">
  17646. <param name="key" type="java.lang.Object"/>
  17647. <param name="value" type="java.lang.Object"/>
  17648. <param name="context" type="org.apache.hadoop.mapreduce.Mapper.Context"/>
  17649. <exception name="IOException" type="java.io.IOException"/>
  17650. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  17651. <doc>
  17652. <![CDATA[Called once for each key/value pair in the input split. Most applications
  17653. should override this, but the default is the identity function.]]>
  17654. </doc>
  17655. </method>
  17656. <method name="cleanup"
  17657. abstract="false" native="false" synchronized="false"
  17658. static="false" final="false" visibility="protected"
  17659. deprecated="not deprecated">
  17660. <param name="context" type="org.apache.hadoop.mapreduce.Mapper.Context"/>
  17661. <exception name="IOException" type="java.io.IOException"/>
  17662. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  17663. <doc>
  17664. <![CDATA[Called once at the end of the task.]]>
  17665. </doc>
  17666. </method>
  17667. <method name="run"
  17668. abstract="false" native="false" synchronized="false"
  17669. static="false" final="false" visibility="public"
  17670. deprecated="not deprecated">
  17671. <param name="context" type="org.apache.hadoop.mapreduce.Mapper.Context"/>
  17672. <exception name="IOException" type="java.io.IOException"/>
  17673. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  17674. <doc>
  17675. <![CDATA[Expert users can override this method for more complete control over the
  17676. execution of the Mapper.
  17677. @param context
  17678. @throws IOException]]>
  17679. </doc>
  17680. </method>
  17681. <doc>
  17682. <![CDATA[Maps input key/value pairs to a set of intermediate key/value pairs.
  17683. <p>Maps are the individual tasks which transform input records into a
  17684. intermediate records. The transformed intermediate records need not be of
  17685. the same type as the input records. A given input pair may map to zero or
  17686. many output pairs.</p>
  17687. <p>The Hadoop Map-Reduce framework spawns one map task for each
  17688. {@link InputSplit} generated by the {@link InputFormat} for the job.
  17689. <code>Mapper</code> implementations can access the {@link Configuration} for
  17690. the job via the {@link JobContext#getConfiguration()}.
  17691. <p>The framework first calls
  17692. {@link #setup(org.apache.hadoop.mapreduce.Mapper.Context)}, followed by
  17693. {@link #map(Object, Object, Context)}
  17694. for each key/value pair in the <code>InputSplit</code>. Finally
  17695. {@link #cleanup(Context)} is called.</p>
  17696. <p>All intermediate values associated with a given output key are
  17697. subsequently grouped by the framework, and passed to a {@link Reducer} to
  17698. determine the final output. Users can control the sorting and grouping by
  17699. specifying two key {@link RawComparator} classes.</p>
  17700. <p>The <code>Mapper</code> outputs are partitioned per
  17701. <code>Reducer</code>. Users can control which keys (and hence records) go to
  17702. which <code>Reducer</code> by implementing a custom {@link Partitioner}.
  17703. <p>Users can optionally specify a <code>combiner</code>, via
  17704. {@link Job#setCombinerClass(Class)}, to perform local aggregation of the
  17705. intermediate outputs, which helps to cut down the amount of data transferred
  17706. from the <code>Mapper</code> to the <code>Reducer</code>.
  17707. <p>Applications can specify if and how the intermediate
  17708. outputs are to be compressed and which {@link CompressionCodec}s are to be
  17709. used via the <code>Configuration</code>.</p>
  17710. <p>If the job has zero
  17711. reduces then the output of the <code>Mapper</code> is directly written
  17712. to the {@link OutputFormat} without sorting by keys.</p>
  17713. <p>Example:</p>
  17714. <p><blockquote><pre>
  17715. public class TokenCounterMapper
  17716. extends Mapper<Object, Text, Text, IntWritable>{
  17717. private final static IntWritable one = new IntWritable(1);
  17718. private Text word = new Text();
  17719. public void map(Object key, Text value, Context context) throws IOException {
  17720. StringTokenizer itr = new StringTokenizer(value.toString());
  17721. while (itr.hasMoreTokens()) {
  17722. word.set(itr.nextToken());
  17723. context.collect(word, one);
  17724. }
  17725. }
  17726. }
  17727. </pre></blockquote></p>
  17728. <p>Applications may override the {@link #run(Context)} method to exert
  17729. greater control on map processing e.g. multi-threaded <code>Mapper</code>s
  17730. etc.</p>
  17731. @see InputFormat
  17732. @see JobContext
  17733. @see Partitioner
  17734. @see Reducer]]>
  17735. </doc>
  17736. </class>
  17737. <!-- end class org.apache.hadoop.mapreduce.Mapper -->
  17738. <!-- start class org.apache.hadoop.mapreduce.Mapper.Context -->
  17739. <class name="Mapper.Context" extends="org.apache.hadoop.mapreduce.MapContext"
  17740. abstract="false"
  17741. static="false" final="false" visibility="public"
  17742. deprecated="not deprecated">
  17743. <constructor name="Mapper.Context" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.mapreduce.TaskAttemptID, org.apache.hadoop.mapreduce.RecordReader, org.apache.hadoop.mapreduce.RecordWriter, org.apache.hadoop.mapreduce.OutputCommitter, org.apache.hadoop.mapreduce.StatusReporter, org.apache.hadoop.mapreduce.InputSplit"
  17744. static="false" final="false" visibility="public"
  17745. deprecated="not deprecated">
  17746. <exception name="IOException" type="java.io.IOException"/>
  17747. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  17748. </constructor>
  17749. </class>
  17750. <!-- end class org.apache.hadoop.mapreduce.Mapper.Context -->
  17751. <!-- start class org.apache.hadoop.mapreduce.OutputCommitter -->
  17752. <class name="OutputCommitter" extends="java.lang.Object"
  17753. abstract="true"
  17754. static="false" final="false" visibility="public"
  17755. deprecated="not deprecated">
  17756. <constructor name="OutputCommitter"
  17757. static="false" final="false" visibility="public"
  17758. deprecated="not deprecated">
  17759. </constructor>
  17760. <method name="setupJob"
  17761. abstract="true" native="false" synchronized="false"
  17762. static="false" final="false" visibility="public"
  17763. deprecated="not deprecated">
  17764. <param name="jobContext" type="org.apache.hadoop.mapreduce.JobContext"/>
  17765. <exception name="IOException" type="java.io.IOException"/>
  17766. <doc>
  17767. <![CDATA[For the framework to setup the job output during initialization
  17768. @param jobContext Context of the job whose output is being written.
  17769. @throws IOException if temporary output could not be created]]>
  17770. </doc>
  17771. </method>
  17772. <method name="cleanupJob"
  17773. abstract="true" native="false" synchronized="false"
  17774. static="false" final="false" visibility="public"
  17775. deprecated="not deprecated">
  17776. <param name="jobContext" type="org.apache.hadoop.mapreduce.JobContext"/>
  17777. <exception name="IOException" type="java.io.IOException"/>
  17778. <doc>
  17779. <![CDATA[For cleaning up the job's output after job completion
  17780. @param jobContext Context of the job whose output is being written.
  17781. @throws IOException]]>
  17782. </doc>
  17783. </method>
  17784. <method name="setupTask"
  17785. abstract="true" native="false" synchronized="false"
  17786. static="false" final="false" visibility="public"
  17787. deprecated="not deprecated">
  17788. <param name="taskContext" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
  17789. <exception name="IOException" type="java.io.IOException"/>
  17790. <doc>
  17791. <![CDATA[Sets up output for the task.
  17792. @param taskContext Context of the task whose output is being written.
  17793. @throws IOException]]>
  17794. </doc>
  17795. </method>
  17796. <method name="needsTaskCommit" return="boolean"
  17797. abstract="true" native="false" synchronized="false"
  17798. static="false" final="false" visibility="public"
  17799. deprecated="not deprecated">
  17800. <param name="taskContext" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
  17801. <exception name="IOException" type="java.io.IOException"/>
  17802. <doc>
  17803. <![CDATA[Check whether task needs a commit
  17804. @param taskContext
  17805. @return true/false
  17806. @throws IOException]]>
  17807. </doc>
  17808. </method>
  17809. <method name="commitTask"
  17810. abstract="true" native="false" synchronized="false"
  17811. static="false" final="false" visibility="public"
  17812. deprecated="not deprecated">
  17813. <param name="taskContext" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
  17814. <exception name="IOException" type="java.io.IOException"/>
  17815. <doc>
  17816. <![CDATA[To promote the task's temporary output to final output location
  17817. The task's output is moved to the job's output directory.
  17818. @param taskContext Context of the task whose output is being written.
  17819. @throws IOException if commit is not]]>
  17820. </doc>
  17821. </method>
  17822. <method name="abortTask"
  17823. abstract="true" native="false" synchronized="false"
  17824. static="false" final="false" visibility="public"
  17825. deprecated="not deprecated">
  17826. <param name="taskContext" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
  17827. <exception name="IOException" type="java.io.IOException"/>
  17828. <doc>
  17829. <![CDATA[Discard the task output
  17830. @param taskContext
  17831. @throws IOException]]>
  17832. </doc>
  17833. </method>
  17834. <doc>
  17835. <![CDATA[<code>OutputCommitter</code> describes the commit of task output for a
  17836. Map-Reduce job.
  17837. <p>The Map-Reduce framework relies on the <code>OutputCommitter</code> of
  17838. the job to:<p>
  17839. <ol>
  17840. <li>
  17841. Setup the job during initialization. For example, create the temporary
  17842. output directory for the job during the initialization of the job.
  17843. </li>
  17844. <li>
  17845. Cleanup the job after the job completion. For example, remove the
  17846. temporary output directory after the job completion.
  17847. </li>
  17848. <li>
  17849. Setup the task temporary output.
  17850. </li>
  17851. <li>
  17852. Check whether a task needs a commit. This is to avoid the commit
  17853. procedure if a task does not need commit.
  17854. </li>
  17855. <li>
  17856. Commit of the task output.
  17857. </li>
  17858. <li>
  17859. Discard the task commit.
  17860. </li>
  17861. </ol>
  17862. @see org.apache.hadoop.mapreduce.lib.output.FileOutputCommitter
  17863. @see JobContext
  17864. @see TaskAttemptContext]]>
  17865. </doc>
  17866. </class>
  17867. <!-- end class org.apache.hadoop.mapreduce.OutputCommitter -->
  17868. <!-- start class org.apache.hadoop.mapreduce.OutputFormat -->
  17869. <class name="OutputFormat" extends="java.lang.Object"
  17870. abstract="true"
  17871. static="false" final="false" visibility="public"
  17872. deprecated="not deprecated">
  17873. <constructor name="OutputFormat"
  17874. static="false" final="false" visibility="public"
  17875. deprecated="not deprecated">
  17876. </constructor>
  17877. <method name="getRecordWriter" return="org.apache.hadoop.mapreduce.RecordWriter"
  17878. abstract="true" native="false" synchronized="false"
  17879. static="false" final="false" visibility="public"
  17880. deprecated="not deprecated">
  17881. <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
  17882. <exception name="IOException" type="java.io.IOException"/>
  17883. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  17884. <doc>
  17885. <![CDATA[Get the {@link RecordWriter} for the given task.
  17886. @param context the information about the current task.
  17887. @return a {@link RecordWriter} to write the output for the job.
  17888. @throws IOException]]>
  17889. </doc>
  17890. </method>
  17891. <method name="checkOutputSpecs"
  17892. abstract="true" native="false" synchronized="false"
  17893. static="false" final="false" visibility="public"
  17894. deprecated="not deprecated">
  17895. <param name="context" type="org.apache.hadoop.mapreduce.JobContext"/>
  17896. <exception name="IOException" type="java.io.IOException"/>
  17897. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  17898. <doc>
  17899. <![CDATA[Check for validity of the output-specification for the job.
  17900. <p>This is to validate the output specification for the job when it is
  17901. a job is submitted. Typically checks that it does not already exist,
  17902. throwing an exception when it already exists, so that output is not
  17903. overwritten.</p>
  17904. @param context information about the job
  17905. @throws IOException when output should not be attempted]]>
  17906. </doc>
  17907. </method>
  17908. <method name="getOutputCommitter" return="org.apache.hadoop.mapreduce.OutputCommitter"
  17909. abstract="true" native="false" synchronized="false"
  17910. static="false" final="false" visibility="public"
  17911. deprecated="not deprecated">
  17912. <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
  17913. <exception name="IOException" type="java.io.IOException"/>
  17914. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  17915. <doc>
  17916. <![CDATA[Get the output committer for this output format. This is responsible
  17917. for ensuring the output is committed correctly.
  17918. @param context the task context
  17919. @return an output committer
  17920. @throws IOException
  17921. @throws InterruptedException]]>
  17922. </doc>
  17923. </method>
  17924. <doc>
  17925. <![CDATA[<code>OutputFormat</code> describes the output-specification for a
  17926. Map-Reduce job.
  17927. <p>The Map-Reduce framework relies on the <code>OutputFormat</code> of the
  17928. job to:<p>
  17929. <ol>
  17930. <li>
  17931. Validate the output-specification of the job. For e.g. check that the
  17932. output directory doesn't already exist.
  17933. <li>
  17934. Provide the {@link RecordWriter} implementation to be used to write out
  17935. the output files of the job. Output files are stored in a
  17936. {@link FileSystem}.
  17937. </li>
  17938. </ol>
  17939. @see RecordWriter]]>
  17940. </doc>
  17941. </class>
  17942. <!-- end class org.apache.hadoop.mapreduce.OutputFormat -->
  17943. <!-- start class org.apache.hadoop.mapreduce.Partitioner -->
  17944. <class name="Partitioner" extends="java.lang.Object"
  17945. abstract="true"
  17946. static="false" final="false" visibility="public"
  17947. deprecated="not deprecated">
  17948. <constructor name="Partitioner"
  17949. static="false" final="false" visibility="public"
  17950. deprecated="not deprecated">
  17951. </constructor>
  17952. <method name="getPartition" return="int"
  17953. abstract="true" native="false" synchronized="false"
  17954. static="false" final="false" visibility="public"
  17955. deprecated="not deprecated">
  17956. <param name="key" type="java.lang.Object"/>
  17957. <param name="value" type="java.lang.Object"/>
  17958. <param name="numPartitions" type="int"/>
  17959. <doc>
  17960. <![CDATA[Get the partition number for a given key (hence record) given the total
  17961. number of partitions i.e. number of reduce-tasks for the job.
  17962. <p>Typically a hash function on a all or a subset of the key.</p>
  17963. @param key the key to be partioned.
  17964. @param value the entry value.
  17965. @param numPartitions the total number of partitions.
  17966. @return the partition number for the <code>key</code>.]]>
  17967. </doc>
  17968. </method>
  17969. <doc>
  17970. <![CDATA[Partitions the key space.
  17971. <p><code>Partitioner</code> controls the partitioning of the keys of the
  17972. intermediate map-outputs. The key (or a subset of the key) is used to derive
  17973. the partition, typically by a hash function. The total number of partitions
  17974. is the same as the number of reduce tasks for the job. Hence this controls
  17975. which of the <code>m</code> reduce tasks the intermediate key (and hence the
  17976. record) is sent for reduction.</p>
  17977. @see Reducer]]>
  17978. </doc>
  17979. </class>
  17980. <!-- end class org.apache.hadoop.mapreduce.Partitioner -->
  17981. <!-- start class org.apache.hadoop.mapreduce.RecordReader -->
  17982. <class name="RecordReader" extends="java.lang.Object"
  17983. abstract="true"
  17984. static="false" final="false" visibility="public"
  17985. deprecated="not deprecated">
  17986. <implements name="java.io.Closeable"/>
  17987. <constructor name="RecordReader"
  17988. static="false" final="false" visibility="public"
  17989. deprecated="not deprecated">
  17990. </constructor>
  17991. <method name="initialize"
  17992. abstract="true" native="false" synchronized="false"
  17993. static="false" final="false" visibility="public"
  17994. deprecated="not deprecated">
  17995. <param name="split" type="org.apache.hadoop.mapreduce.InputSplit"/>
  17996. <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
  17997. <exception name="IOException" type="java.io.IOException"/>
  17998. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  17999. <doc>
  18000. <![CDATA[Called once at initialization.
  18001. @param split the split that defines the range of records to read
  18002. @param context the information about the task
  18003. @throws IOException
  18004. @throws InterruptedException]]>
  18005. </doc>
  18006. </method>
  18007. <method name="nextKeyValue" return="boolean"
  18008. abstract="true" native="false" synchronized="false"
  18009. static="false" final="false" visibility="public"
  18010. deprecated="not deprecated">
  18011. <exception name="IOException" type="java.io.IOException"/>
  18012. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  18013. <doc>
  18014. <![CDATA[Read the next key, value pair.
  18015. @return true if a key/value pair was read
  18016. @throws IOException
  18017. @throws InterruptedException]]>
  18018. </doc>
  18019. </method>
  18020. <method name="getCurrentKey" return="java.lang.Object"
  18021. abstract="true" native="false" synchronized="false"
  18022. static="false" final="false" visibility="public"
  18023. deprecated="not deprecated">
  18024. <exception name="IOException" type="java.io.IOException"/>
  18025. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  18026. <doc>
  18027. <![CDATA[Get the current key
  18028. @return the current key or null if there is no current key
  18029. @throws IOException
  18030. @throws InterruptedException]]>
  18031. </doc>
  18032. </method>
  18033. <method name="getCurrentValue" return="java.lang.Object"
  18034. abstract="true" native="false" synchronized="false"
  18035. static="false" final="false" visibility="public"
  18036. deprecated="not deprecated">
  18037. <exception name="IOException" type="java.io.IOException"/>
  18038. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  18039. <doc>
  18040. <![CDATA[Get the current value.
  18041. @return the object that was read
  18042. @throws IOException
  18043. @throws InterruptedException]]>
  18044. </doc>
  18045. </method>
  18046. <method name="getProgress" return="float"
  18047. abstract="true" native="false" synchronized="false"
  18048. static="false" final="false" visibility="public"
  18049. deprecated="not deprecated">
  18050. <exception name="IOException" type="java.io.IOException"/>
  18051. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  18052. <doc>
  18053. <![CDATA[The current progress of the record reader through its data.
  18054. @return a number between 0.0 and 1.0 that is the fraction of the data read
  18055. @throws IOException
  18056. @throws InterruptedException]]>
  18057. </doc>
  18058. </method>
  18059. <method name="close"
  18060. abstract="true" native="false" synchronized="false"
  18061. static="false" final="false" visibility="public"
  18062. deprecated="not deprecated">
  18063. <exception name="IOException" type="java.io.IOException"/>
  18064. <doc>
  18065. <![CDATA[Close the record reader.]]>
  18066. </doc>
  18067. </method>
  18068. <doc>
  18069. <![CDATA[The record reader breaks the data into key/value pairs for input to the
  18070. {@link Mapper}.
  18071. @param <KEYIN>
  18072. @param <VALUEIN>]]>
  18073. </doc>
  18074. </class>
  18075. <!-- end class org.apache.hadoop.mapreduce.RecordReader -->
  18076. <!-- start class org.apache.hadoop.mapreduce.RecordWriter -->
  18077. <class name="RecordWriter" extends="java.lang.Object"
  18078. abstract="true"
  18079. static="false" final="false" visibility="public"
  18080. deprecated="not deprecated">
  18081. <constructor name="RecordWriter"
  18082. static="false" final="false" visibility="public"
  18083. deprecated="not deprecated">
  18084. </constructor>
  18085. <method name="write"
  18086. abstract="true" native="false" synchronized="false"
  18087. static="false" final="false" visibility="public"
  18088. deprecated="not deprecated">
  18089. <param name="key" type="java.lang.Object"/>
  18090. <param name="value" type="java.lang.Object"/>
  18091. <exception name="IOException" type="java.io.IOException"/>
  18092. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  18093. <doc>
  18094. <![CDATA[Writes a key/value pair.
  18095. @param key the key to write.
  18096. @param value the value to write.
  18097. @throws IOException]]>
  18098. </doc>
  18099. </method>
  18100. <method name="close"
  18101. abstract="true" native="false" synchronized="false"
  18102. static="false" final="false" visibility="public"
  18103. deprecated="not deprecated">
  18104. <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
  18105. <exception name="IOException" type="java.io.IOException"/>
  18106. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  18107. <doc>
  18108. <![CDATA[Close this <code>RecordWriter</code> to future operations.
  18109. @param context the context of the task
  18110. @throws IOException]]>
  18111. </doc>
  18112. </method>
  18113. <doc>
  18114. <![CDATA[<code>RecordWriter</code> writes the output &lt;key, value&gt; pairs
  18115. to an output file.
  18116. <p><code>RecordWriter</code> implementations write the job outputs to the
  18117. {@link FileSystem}.
  18118. @see OutputFormat]]>
  18119. </doc>
  18120. </class>
  18121. <!-- end class org.apache.hadoop.mapreduce.RecordWriter -->
  18122. <!-- start class org.apache.hadoop.mapreduce.ReduceContext -->
  18123. <class name="ReduceContext" extends="org.apache.hadoop.mapreduce.TaskInputOutputContext"
  18124. abstract="false"
  18125. static="false" final="false" visibility="public"
  18126. deprecated="not deprecated">
  18127. <constructor name="ReduceContext" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.mapreduce.TaskAttemptID, org.apache.hadoop.mapred.RawKeyValueIterator, org.apache.hadoop.mapreduce.Counter, org.apache.hadoop.mapreduce.RecordWriter, org.apache.hadoop.mapreduce.OutputCommitter, org.apache.hadoop.mapreduce.StatusReporter, org.apache.hadoop.io.RawComparator, java.lang.Class, java.lang.Class"
  18128. static="false" final="false" visibility="public"
  18129. deprecated="not deprecated">
  18130. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  18131. <exception name="IOException" type="java.io.IOException"/>
  18132. </constructor>
  18133. <method name="nextKey" return="boolean"
  18134. abstract="false" native="false" synchronized="false"
  18135. static="false" final="false" visibility="public"
  18136. deprecated="not deprecated">
  18137. <exception name="IOException" type="java.io.IOException"/>
  18138. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  18139. <doc>
  18140. <![CDATA[Start processing next unique key.]]>
  18141. </doc>
  18142. </method>
  18143. <method name="nextKeyValue" return="boolean"
  18144. abstract="false" native="false" synchronized="false"
  18145. static="false" final="false" visibility="public"
  18146. deprecated="not deprecated">
  18147. <exception name="IOException" type="java.io.IOException"/>
  18148. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  18149. <doc>
  18150. <![CDATA[Advance to the next key/value pair.]]>
  18151. </doc>
  18152. </method>
  18153. <method name="getCurrentKey" return="java.lang.Object"
  18154. abstract="false" native="false" synchronized="false"
  18155. static="false" final="false" visibility="public"
  18156. deprecated="not deprecated">
  18157. </method>
  18158. <method name="getCurrentValue" return="java.lang.Object"
  18159. abstract="false" native="false" synchronized="false"
  18160. static="false" final="false" visibility="public"
  18161. deprecated="not deprecated">
  18162. </method>
  18163. <method name="getValues" return="java.lang.Iterable"
  18164. abstract="false" native="false" synchronized="false"
  18165. static="false" final="false" visibility="public"
  18166. deprecated="not deprecated">
  18167. <exception name="IOException" type="java.io.IOException"/>
  18168. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  18169. <doc>
  18170. <![CDATA[Iterate through the values for the current key, reusing the same value
  18171. object, which is stored in the context.
  18172. @return the series of values associated with the current key. All of the
  18173. objects returned directly and indirectly from this method are reused.]]>
  18174. </doc>
  18175. </method>
  18176. <field name="reporter" type="org.apache.hadoop.util.Progressable"
  18177. transient="false" volatile="false"
  18178. static="false" final="false" visibility="protected"
  18179. deprecated="not deprecated">
  18180. </field>
  18181. <doc>
  18182. <![CDATA[The context passed to the {@link Reducer}.
  18183. @param <KEYIN> the class of the input keys
  18184. @param <VALUEIN> the class of the input values
  18185. @param <KEYOUT> the class of the output keys
  18186. @param <VALUEOUT> the class of the output values]]>
  18187. </doc>
  18188. </class>
  18189. <!-- end class org.apache.hadoop.mapreduce.ReduceContext -->
  18190. <!-- start class org.apache.hadoop.mapreduce.ReduceContext.ValueIterable -->
  18191. <class name="ReduceContext.ValueIterable" extends="java.lang.Object"
  18192. abstract="false"
  18193. static="false" final="false" visibility="protected"
  18194. deprecated="not deprecated">
  18195. <implements name="java.lang.Iterable"/>
  18196. <constructor name="ReduceContext.ValueIterable"
  18197. static="false" final="false" visibility="protected"
  18198. deprecated="not deprecated">
  18199. </constructor>
  18200. <method name="iterator" return="java.util.Iterator"
  18201. abstract="false" native="false" synchronized="false"
  18202. static="false" final="false" visibility="public"
  18203. deprecated="not deprecated">
  18204. </method>
  18205. </class>
  18206. <!-- end class org.apache.hadoop.mapreduce.ReduceContext.ValueIterable -->
  18207. <!-- start class org.apache.hadoop.mapreduce.ReduceContext.ValueIterator -->
  18208. <class name="ReduceContext.ValueIterator" extends="java.lang.Object"
  18209. abstract="false"
  18210. static="false" final="false" visibility="protected"
  18211. deprecated="not deprecated">
  18212. <implements name="java.util.Iterator"/>
  18213. <constructor name="ReduceContext.ValueIterator"
  18214. static="false" final="false" visibility="protected"
  18215. deprecated="not deprecated">
  18216. </constructor>
  18217. <method name="hasNext" return="boolean"
  18218. abstract="false" native="false" synchronized="false"
  18219. static="false" final="false" visibility="public"
  18220. deprecated="not deprecated">
  18221. </method>
  18222. <method name="next" return="java.lang.Object"
  18223. abstract="false" native="false" synchronized="false"
  18224. static="false" final="false" visibility="public"
  18225. deprecated="not deprecated">
  18226. </method>
  18227. <method name="remove"
  18228. abstract="false" native="false" synchronized="false"
  18229. static="false" final="false" visibility="public"
  18230. deprecated="not deprecated">
  18231. </method>
  18232. </class>
  18233. <!-- end class org.apache.hadoop.mapreduce.ReduceContext.ValueIterator -->
  18234. <!-- start class org.apache.hadoop.mapreduce.Reducer -->
  18235. <class name="Reducer" extends="java.lang.Object"
  18236. abstract="true"
  18237. static="false" final="false" visibility="public"
  18238. deprecated="not deprecated">
  18239. <constructor name="Reducer"
  18240. static="false" final="false" visibility="public"
  18241. deprecated="not deprecated">
  18242. </constructor>
  18243. <method name="setup"
  18244. abstract="false" native="false" synchronized="false"
  18245. static="false" final="false" visibility="protected"
  18246. deprecated="not deprecated">
  18247. <param name="context" type="org.apache.hadoop.mapreduce.Reducer.Context"/>
  18248. <exception name="IOException" type="java.io.IOException"/>
  18249. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  18250. <doc>
  18251. <![CDATA[Called once at the start of the task.]]>
  18252. </doc>
  18253. </method>
  18254. <method name="reduce"
  18255. abstract="false" native="false" synchronized="false"
  18256. static="false" final="false" visibility="protected"
  18257. deprecated="not deprecated">
  18258. <param name="key" type="java.lang.Object"/>
  18259. <param name="values" type="java.lang.Iterable"/>
  18260. <param name="context" type="org.apache.hadoop.mapreduce.Reducer.Context"/>
  18261. <exception name="IOException" type="java.io.IOException"/>
  18262. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  18263. <doc>
  18264. <![CDATA[This method is called once for each key. Most applications will define
  18265. their reduce class by overriding this method. The default implementation
  18266. is an identity function.]]>
  18267. </doc>
  18268. </method>
  18269. <method name="cleanup"
  18270. abstract="false" native="false" synchronized="false"
  18271. static="false" final="false" visibility="protected"
  18272. deprecated="not deprecated">
  18273. <param name="context" type="org.apache.hadoop.mapreduce.Reducer.Context"/>
  18274. <exception name="IOException" type="java.io.IOException"/>
  18275. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  18276. <doc>
  18277. <![CDATA[Called once at the end of the task.]]>
  18278. </doc>
  18279. </method>
  18280. <method name="run"
  18281. abstract="false" native="false" synchronized="false"
  18282. static="false" final="false" visibility="public"
  18283. deprecated="not deprecated">
  18284. <param name="context" type="org.apache.hadoop.mapreduce.Reducer.Context"/>
  18285. <exception name="IOException" type="java.io.IOException"/>
  18286. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  18287. <doc>
  18288. <![CDATA[Advanced application writers can use the
  18289. {@link #run(org.apache.hadoop.mapreduce.Reducer.Context)} method to
  18290. control how the reduce task works.]]>
  18291. </doc>
  18292. </method>
  18293. <doc>
  18294. <![CDATA[Reduces a set of intermediate values which share a key to a smaller set of
  18295. values.
  18296. <p><code>Reducer</code> implementations
  18297. can access the {@link Configuration} for the job via the
  18298. {@link JobContext#getConfiguration()} method.</p>
  18299. <p><code>Reducer</code> has 3 primary phases:</p>
  18300. <ol>
  18301. <li>
  18302. <h4 id="Shuffle">Shuffle</h4>
  18303. <p>The <code>Reducer</code> copies the sorted output from each
  18304. {@link Mapper} using HTTP across the network.</p>
  18305. </li>
  18306. <li>
  18307. <h4 id="Sort">Sort</h4>
  18308. <p>The framework merge sorts <code>Reducer</code> inputs by
  18309. <code>key</code>s
  18310. (since different <code>Mapper</code>s may have output the same key).</p>
  18311. <p>The shuffle and sort phases occur simultaneously i.e. while outputs are
  18312. being fetched they are merged.</p>
  18313. <h5 id="SecondarySort">SecondarySort</h5>
  18314. <p>To achieve a secondary sort on the values returned by the value
  18315. iterator, the application should extend the key with the secondary
  18316. key and define a grouping comparator. The keys will be sorted using the
  18317. entire key, but will be grouped using the grouping comparator to decide
  18318. which keys and values are sent in the same call to reduce.The grouping
  18319. comparator is specified via
  18320. {@link Job#setGroupingComparatorClass(Class)}. The sort order is
  18321. controlled by
  18322. {@link Job#setSortComparatorClass(Class)}.</p>
  18323. For example, say that you want to find duplicate web pages and tag them
  18324. all with the url of the "best" known example. You would set up the job
  18325. like:
  18326. <ul>
  18327. <li>Map Input Key: url</li>
  18328. <li>Map Input Value: document</li>
  18329. <li>Map Output Key: document checksum, url pagerank</li>
  18330. <li>Map Output Value: url</li>
  18331. <li>Partitioner: by checksum</li>
  18332. <li>OutputKeyComparator: by checksum and then decreasing pagerank</li>
  18333. <li>OutputValueGroupingComparator: by checksum</li>
  18334. </ul>
  18335. </li>
  18336. <li>
  18337. <h4 id="Reduce">Reduce</h4>
  18338. <p>In this phase the
  18339. {@link #reduce(Object, Iterable, Context)}
  18340. method is called for each <code>&lt;key, (collection of values)></code> in
  18341. the sorted inputs.</p>
  18342. <p>The output of the reduce task is typically written to a
  18343. {@link RecordWriter} via
  18344. {@link Context#write(Object, Object)}.</p>
  18345. </li>
  18346. </ol>
  18347. <p>The output of the <code>Reducer</code> is <b>not re-sorted</b>.</p>
  18348. <p>Example:</p>
  18349. <p><blockquote><pre>
  18350. public class IntSumReducer<Key> extends Reducer<Key,IntWritable,
  18351. Key,IntWritable> {
  18352. private IntWritable result = new IntWritable();
  18353. public void reduce(Key key, Iterable<IntWritable> values,
  18354. Context context) throws IOException {
  18355. int sum = 0;
  18356. for (IntWritable val : values) {
  18357. sum += val.get();
  18358. }
  18359. result.set(sum);
  18360. context.collect(key, result);
  18361. }
  18362. }
  18363. </pre></blockquote></p>
  18364. @see Mapper
  18365. @see Partitioner]]>
  18366. </doc>
  18367. </class>
  18368. <!-- end class org.apache.hadoop.mapreduce.Reducer -->
  18369. <!-- start class org.apache.hadoop.mapreduce.Reducer.Context -->
  18370. <class name="Reducer.Context" extends="org.apache.hadoop.mapreduce.ReduceContext"
  18371. abstract="false"
  18372. static="false" final="false" visibility="public"
  18373. deprecated="not deprecated">
  18374. <constructor name="Reducer.Context" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.mapreduce.TaskAttemptID, org.apache.hadoop.mapred.RawKeyValueIterator, org.apache.hadoop.mapreduce.Counter, org.apache.hadoop.mapreduce.RecordWriter, org.apache.hadoop.mapreduce.OutputCommitter, org.apache.hadoop.mapreduce.StatusReporter, org.apache.hadoop.io.RawComparator, java.lang.Class, java.lang.Class"
  18375. static="false" final="false" visibility="public"
  18376. deprecated="not deprecated">
  18377. <exception name="IOException" type="java.io.IOException"/>
  18378. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  18379. </constructor>
  18380. </class>
  18381. <!-- end class org.apache.hadoop.mapreduce.Reducer.Context -->
  18382. <!-- start class org.apache.hadoop.mapreduce.StatusReporter -->
  18383. <class name="StatusReporter" extends="java.lang.Object"
  18384. abstract="true"
  18385. static="false" final="false" visibility="public"
  18386. deprecated="not deprecated">
  18387. <constructor name="StatusReporter"
  18388. static="false" final="false" visibility="public"
  18389. deprecated="not deprecated">
  18390. </constructor>
  18391. <method name="getCounter" return="org.apache.hadoop.mapreduce.Counter"
  18392. abstract="true" native="false" synchronized="false"
  18393. static="false" final="false" visibility="public"
  18394. deprecated="not deprecated">
  18395. <param name="name" type="java.lang.Enum"/>
  18396. </method>
  18397. <method name="getCounter" return="org.apache.hadoop.mapreduce.Counter"
  18398. abstract="true" native="false" synchronized="false"
  18399. static="false" final="false" visibility="public"
  18400. deprecated="not deprecated">
  18401. <param name="group" type="java.lang.String"/>
  18402. <param name="name" type="java.lang.String"/>
  18403. </method>
  18404. <method name="progress"
  18405. abstract="true" native="false" synchronized="false"
  18406. static="false" final="false" visibility="public"
  18407. deprecated="not deprecated">
  18408. </method>
  18409. <method name="setStatus"
  18410. abstract="true" native="false" synchronized="false"
  18411. static="false" final="false" visibility="public"
  18412. deprecated="not deprecated">
  18413. <param name="status" type="java.lang.String"/>
  18414. </method>
  18415. </class>
  18416. <!-- end class org.apache.hadoop.mapreduce.StatusReporter -->
  18417. <!-- start class org.apache.hadoop.mapreduce.TaskAttemptContext -->
  18418. <class name="TaskAttemptContext" extends="org.apache.hadoop.mapreduce.JobContext"
  18419. abstract="false"
  18420. static="false" final="false" visibility="public"
  18421. deprecated="not deprecated">
  18422. <implements name="org.apache.hadoop.util.Progressable"/>
  18423. <constructor name="TaskAttemptContext" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.mapreduce.TaskAttemptID"
  18424. static="false" final="false" visibility="public"
  18425. deprecated="not deprecated">
  18426. </constructor>
  18427. <method name="getTaskAttemptID" return="org.apache.hadoop.mapreduce.TaskAttemptID"
  18428. abstract="false" native="false" synchronized="false"
  18429. static="false" final="false" visibility="public"
  18430. deprecated="not deprecated">
  18431. <doc>
  18432. <![CDATA[Get the unique name for this task attempt.]]>
  18433. </doc>
  18434. </method>
  18435. <method name="setStatus"
  18436. abstract="false" native="false" synchronized="false"
  18437. static="false" final="false" visibility="public"
  18438. deprecated="not deprecated">
  18439. <param name="msg" type="java.lang.String"/>
  18440. <exception name="IOException" type="java.io.IOException"/>
  18441. <doc>
  18442. <![CDATA[Set the current status of the task to the given string.]]>
  18443. </doc>
  18444. </method>
  18445. <method name="getStatus" return="java.lang.String"
  18446. abstract="false" native="false" synchronized="false"
  18447. static="false" final="false" visibility="public"
  18448. deprecated="not deprecated">
  18449. <doc>
  18450. <![CDATA[Get the last set status message.
  18451. @return the current status message]]>
  18452. </doc>
  18453. </method>
  18454. <method name="progress"
  18455. abstract="false" native="false" synchronized="false"
  18456. static="false" final="false" visibility="public"
  18457. deprecated="not deprecated">
  18458. <doc>
  18459. <![CDATA[Report progress. The subtypes actually do work in this method.]]>
  18460. </doc>
  18461. </method>
  18462. <doc>
  18463. <![CDATA[The context for task attempts.]]>
  18464. </doc>
  18465. </class>
  18466. <!-- end class org.apache.hadoop.mapreduce.TaskAttemptContext -->
  18467. <!-- start class org.apache.hadoop.mapreduce.TaskAttemptID -->
  18468. <class name="TaskAttemptID" extends="org.apache.hadoop.mapred.ID"
  18469. abstract="false"
  18470. static="false" final="false" visibility="public"
  18471. deprecated="not deprecated">
  18472. <constructor name="TaskAttemptID" type="org.apache.hadoop.mapreduce.TaskID, int"
  18473. static="false" final="false" visibility="public"
  18474. deprecated="not deprecated">
  18475. <doc>
  18476. <![CDATA[Constructs a TaskAttemptID object from given {@link TaskID}.
  18477. @param taskId TaskID that this task belongs to
  18478. @param id the task attempt number]]>
  18479. </doc>
  18480. </constructor>
  18481. <constructor name="TaskAttemptID" type="java.lang.String, int, boolean, int, int"
  18482. static="false" final="false" visibility="public"
  18483. deprecated="not deprecated">
  18484. <doc>
  18485. <![CDATA[Constructs a TaskId object from given parts.
  18486. @param jtIdentifier jobTracker identifier
  18487. @param jobId job number
  18488. @param isMap whether the tip is a map
  18489. @param taskId taskId number
  18490. @param id the task attempt number]]>
  18491. </doc>
  18492. </constructor>
  18493. <constructor name="TaskAttemptID"
  18494. static="false" final="false" visibility="public"
  18495. deprecated="not deprecated">
  18496. </constructor>
  18497. <method name="getJobID" return="org.apache.hadoop.mapreduce.JobID"
  18498. abstract="false" native="false" synchronized="false"
  18499. static="false" final="false" visibility="public"
  18500. deprecated="not deprecated">
  18501. <doc>
  18502. <![CDATA[Returns the {@link JobID} object that this task attempt belongs to]]>
  18503. </doc>
  18504. </method>
  18505. <method name="getTaskID" return="org.apache.hadoop.mapreduce.TaskID"
  18506. abstract="false" native="false" synchronized="false"
  18507. static="false" final="false" visibility="public"
  18508. deprecated="not deprecated">
  18509. <doc>
  18510. <![CDATA[Returns the {@link TaskID} object that this task attempt belongs to]]>
  18511. </doc>
  18512. </method>
  18513. <method name="isMap" return="boolean"
  18514. abstract="false" native="false" synchronized="false"
  18515. static="false" final="false" visibility="public"
  18516. deprecated="not deprecated">
  18517. <doc>
  18518. <![CDATA[Returns whether this TaskAttemptID is a map ID]]>
  18519. </doc>
  18520. </method>
  18521. <method name="equals" return="boolean"
  18522. abstract="false" native="false" synchronized="false"
  18523. static="false" final="false" visibility="public"
  18524. deprecated="not deprecated">
  18525. <param name="o" type="java.lang.Object"/>
  18526. </method>
  18527. <method name="appendTo" return="java.lang.StringBuilder"
  18528. abstract="false" native="false" synchronized="false"
  18529. static="false" final="false" visibility="protected"
  18530. deprecated="not deprecated">
  18531. <param name="builder" type="java.lang.StringBuilder"/>
  18532. <doc>
  18533. <![CDATA[Add the unique string to the StringBuilder
  18534. @param builder the builder to append ot
  18535. @return the builder that was passed in.]]>
  18536. </doc>
  18537. </method>
  18538. <method name="readFields"
  18539. abstract="false" native="false" synchronized="false"
  18540. static="false" final="false" visibility="public"
  18541. deprecated="not deprecated">
  18542. <param name="in" type="java.io.DataInput"/>
  18543. <exception name="IOException" type="java.io.IOException"/>
  18544. </method>
  18545. <method name="write"
  18546. abstract="false" native="false" synchronized="false"
  18547. static="false" final="false" visibility="public"
  18548. deprecated="not deprecated">
  18549. <param name="out" type="java.io.DataOutput"/>
  18550. <exception name="IOException" type="java.io.IOException"/>
  18551. </method>
  18552. <method name="hashCode" return="int"
  18553. abstract="false" native="false" synchronized="false"
  18554. static="false" final="false" visibility="public"
  18555. deprecated="not deprecated">
  18556. </method>
  18557. <method name="compareTo" return="int"
  18558. abstract="false" native="false" synchronized="false"
  18559. static="false" final="false" visibility="public"
  18560. deprecated="not deprecated">
  18561. <param name="o" type="org.apache.hadoop.mapreduce.ID"/>
  18562. <doc>
  18563. <![CDATA[Compare TaskIds by first tipIds, then by task numbers.]]>
  18564. </doc>
  18565. </method>
  18566. <method name="toString" return="java.lang.String"
  18567. abstract="false" native="false" synchronized="false"
  18568. static="false" final="false" visibility="public"
  18569. deprecated="not deprecated">
  18570. </method>
  18571. <method name="forName" return="org.apache.hadoop.mapreduce.TaskAttemptID"
  18572. abstract="false" native="false" synchronized="false"
  18573. static="true" final="false" visibility="public"
  18574. deprecated="not deprecated">
  18575. <param name="str" type="java.lang.String"/>
  18576. <exception name="IllegalArgumentException" type="java.lang.IllegalArgumentException"/>
  18577. <doc>
  18578. <![CDATA[Construct a TaskAttemptID object from given string
  18579. @return constructed TaskAttemptID object or null if the given String is null
  18580. @throws IllegalArgumentException if the given string is malformed]]>
  18581. </doc>
  18582. </method>
  18583. <field name="ATTEMPT" type="java.lang.String"
  18584. transient="false" volatile="false"
  18585. static="true" final="true" visibility="protected"
  18586. deprecated="not deprecated">
  18587. </field>
  18588. <doc>
  18589. <![CDATA[TaskAttemptID represents the immutable and unique identifier for
  18590. a task attempt. Each task attempt is one particular instance of a Map or
  18591. Reduce Task identified by its TaskID.
  18592. TaskAttemptID consists of 2 parts. First part is the
  18593. {@link TaskID}, that this TaskAttemptID belongs to.
  18594. Second part is the task attempt number. <br>
  18595. An example TaskAttemptID is :
  18596. <code>attempt_200707121733_0003_m_000005_0</code> , which represents the
  18597. zeroth task attempt for the fifth map task in the third job
  18598. running at the jobtracker started at <code>200707121733</code>.
  18599. <p>
  18600. Applications should never construct or parse TaskAttemptID strings
  18601. , but rather use appropriate constructors or {@link #forName(String)}
  18602. method.
  18603. @see JobID
  18604. @see TaskID]]>
  18605. </doc>
  18606. </class>
  18607. <!-- end class org.apache.hadoop.mapreduce.TaskAttemptID -->
  18608. <!-- start class org.apache.hadoop.mapreduce.TaskID -->
  18609. <class name="TaskID" extends="org.apache.hadoop.mapred.ID"
  18610. abstract="false"
  18611. static="false" final="false" visibility="public"
  18612. deprecated="not deprecated">
  18613. <constructor name="TaskID" type="org.apache.hadoop.mapreduce.JobID, boolean, int"
  18614. static="false" final="false" visibility="public"
  18615. deprecated="not deprecated">
  18616. <doc>
  18617. <![CDATA[Constructs a TaskID object from given {@link JobID}.
  18618. @param jobId JobID that this tip belongs to
  18619. @param isMap whether the tip is a map
  18620. @param id the tip number]]>
  18621. </doc>
  18622. </constructor>
  18623. <constructor name="TaskID" type="java.lang.String, int, boolean, int"
  18624. static="false" final="false" visibility="public"
  18625. deprecated="not deprecated">
  18626. <doc>
  18627. <![CDATA[Constructs a TaskInProgressId object from given parts.
  18628. @param jtIdentifier jobTracker identifier
  18629. @param jobId job number
  18630. @param isMap whether the tip is a map
  18631. @param id the tip number]]>
  18632. </doc>
  18633. </constructor>
  18634. <constructor name="TaskID"
  18635. static="false" final="false" visibility="public"
  18636. deprecated="not deprecated">
  18637. </constructor>
  18638. <method name="getJobID" return="org.apache.hadoop.mapreduce.JobID"
  18639. abstract="false" native="false" synchronized="false"
  18640. static="false" final="false" visibility="public"
  18641. deprecated="not deprecated">
  18642. <doc>
  18643. <![CDATA[Returns the {@link JobID} object that this tip belongs to]]>
  18644. </doc>
  18645. </method>
  18646. <method name="isMap" return="boolean"
  18647. abstract="false" native="false" synchronized="false"
  18648. static="false" final="false" visibility="public"
  18649. deprecated="not deprecated">
  18650. <doc>
  18651. <![CDATA[Returns whether this TaskID is a map ID]]>
  18652. </doc>
  18653. </method>
  18654. <method name="equals" return="boolean"
  18655. abstract="false" native="false" synchronized="false"
  18656. static="false" final="false" visibility="public"
  18657. deprecated="not deprecated">
  18658. <param name="o" type="java.lang.Object"/>
  18659. </method>
  18660. <method name="compareTo" return="int"
  18661. abstract="false" native="false" synchronized="false"
  18662. static="false" final="false" visibility="public"
  18663. deprecated="not deprecated">
  18664. <param name="o" type="org.apache.hadoop.mapreduce.ID"/>
  18665. <doc>
  18666. <![CDATA[Compare TaskInProgressIds by first jobIds, then by tip numbers. Reduces are
  18667. defined as greater then maps.]]>
  18668. </doc>
  18669. </method>
  18670. <method name="toString" return="java.lang.String"
  18671. abstract="false" native="false" synchronized="false"
  18672. static="false" final="false" visibility="public"
  18673. deprecated="not deprecated">
  18674. </method>
  18675. <method name="appendTo" return="java.lang.StringBuilder"
  18676. abstract="false" native="false" synchronized="false"
  18677. static="false" final="false" visibility="protected"
  18678. deprecated="not deprecated">
  18679. <param name="builder" type="java.lang.StringBuilder"/>
  18680. <doc>
  18681. <![CDATA[Add the unique string to the given builder.
  18682. @param builder the builder to append to
  18683. @return the builder that was passed in]]>
  18684. </doc>
  18685. </method>
  18686. <method name="hashCode" return="int"
  18687. abstract="false" native="false" synchronized="false"
  18688. static="false" final="false" visibility="public"
  18689. deprecated="not deprecated">
  18690. </method>
  18691. <method name="readFields"
  18692. abstract="false" native="false" synchronized="false"
  18693. static="false" final="false" visibility="public"
  18694. deprecated="not deprecated">
  18695. <param name="in" type="java.io.DataInput"/>
  18696. <exception name="IOException" type="java.io.IOException"/>
  18697. </method>
  18698. <method name="write"
  18699. abstract="false" native="false" synchronized="false"
  18700. static="false" final="false" visibility="public"
  18701. deprecated="not deprecated">
  18702. <param name="out" type="java.io.DataOutput"/>
  18703. <exception name="IOException" type="java.io.IOException"/>
  18704. </method>
  18705. <method name="forName" return="org.apache.hadoop.mapreduce.TaskID"
  18706. abstract="false" native="false" synchronized="false"
  18707. static="true" final="false" visibility="public"
  18708. deprecated="not deprecated">
  18709. <param name="str" type="java.lang.String"/>
  18710. <exception name="IllegalArgumentException" type="java.lang.IllegalArgumentException"/>
  18711. <doc>
  18712. <![CDATA[Construct a TaskID object from given string
  18713. @return constructed TaskID object or null if the given String is null
  18714. @throws IllegalArgumentException if the given string is malformed]]>
  18715. </doc>
  18716. </method>
  18717. <field name="TASK" type="java.lang.String"
  18718. transient="false" volatile="false"
  18719. static="true" final="true" visibility="protected"
  18720. deprecated="not deprecated">
  18721. </field>
  18722. <field name="idFormat" type="java.text.NumberFormat"
  18723. transient="false" volatile="false"
  18724. static="true" final="true" visibility="protected"
  18725. deprecated="not deprecated">
  18726. </field>
  18727. <doc>
  18728. <![CDATA[TaskID represents the immutable and unique identifier for
  18729. a Map or Reduce Task. Each TaskID encompasses multiple attempts made to
  18730. execute the Map or Reduce Task, each of which are uniquely indentified by
  18731. their TaskAttemptID.
  18732. TaskID consists of 3 parts. First part is the {@link JobID}, that this
  18733. TaskInProgress belongs to. Second part of the TaskID is either 'm' or 'r'
  18734. representing whether the task is a map task or a reduce task.
  18735. And the third part is the task number. <br>
  18736. An example TaskID is :
  18737. <code>task_200707121733_0003_m_000005</code> , which represents the
  18738. fifth map task in the third job running at the jobtracker
  18739. started at <code>200707121733</code>.
  18740. <p>
  18741. Applications should never construct or parse TaskID strings
  18742. , but rather use appropriate constructors or {@link #forName(String)}
  18743. method.
  18744. @see JobID
  18745. @see TaskAttemptID]]>
  18746. </doc>
  18747. </class>
  18748. <!-- end class org.apache.hadoop.mapreduce.TaskID -->
  18749. <!-- start class org.apache.hadoop.mapreduce.TaskInputOutputContext -->
  18750. <class name="TaskInputOutputContext" extends="org.apache.hadoop.mapreduce.TaskAttemptContext"
  18751. abstract="true"
  18752. static="false" final="false" visibility="public"
  18753. deprecated="not deprecated">
  18754. <implements name="org.apache.hadoop.util.Progressable"/>
  18755. <constructor name="TaskInputOutputContext" type="org.apache.hadoop.conf.Configuration, org.apache.hadoop.mapreduce.TaskAttemptID, org.apache.hadoop.mapreduce.RecordWriter, org.apache.hadoop.mapreduce.OutputCommitter, org.apache.hadoop.mapreduce.StatusReporter"
  18756. static="false" final="false" visibility="public"
  18757. deprecated="not deprecated">
  18758. </constructor>
  18759. <method name="nextKeyValue" return="boolean"
  18760. abstract="true" native="false" synchronized="false"
  18761. static="false" final="false" visibility="public"
  18762. deprecated="not deprecated">
  18763. <exception name="IOException" type="java.io.IOException"/>
  18764. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  18765. <doc>
  18766. <![CDATA[Advance to the next key, value pair, returning null if at end.
  18767. @return the key object that was read into, or null if no more]]>
  18768. </doc>
  18769. </method>
  18770. <method name="getCurrentKey" return="java.lang.Object"
  18771. abstract="true" native="false" synchronized="false"
  18772. static="false" final="false" visibility="public"
  18773. deprecated="not deprecated">
  18774. <exception name="IOException" type="java.io.IOException"/>
  18775. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  18776. <doc>
  18777. <![CDATA[Get the current key.
  18778. @return the current key object or null if there isn't one
  18779. @throws IOException
  18780. @throws InterruptedException]]>
  18781. </doc>
  18782. </method>
  18783. <method name="getCurrentValue" return="java.lang.Object"
  18784. abstract="true" native="false" synchronized="false"
  18785. static="false" final="false" visibility="public"
  18786. deprecated="not deprecated">
  18787. <exception name="IOException" type="java.io.IOException"/>
  18788. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  18789. <doc>
  18790. <![CDATA[Get the current value.
  18791. @return the value object that was read into
  18792. @throws IOException
  18793. @throws InterruptedException]]>
  18794. </doc>
  18795. </method>
  18796. <method name="write"
  18797. abstract="false" native="false" synchronized="false"
  18798. static="false" final="false" visibility="public"
  18799. deprecated="not deprecated">
  18800. <param name="key" type="java.lang.Object"/>
  18801. <param name="value" type="java.lang.Object"/>
  18802. <exception name="IOException" type="java.io.IOException"/>
  18803. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  18804. <doc>
  18805. <![CDATA[Generate an output key/value pair.]]>
  18806. </doc>
  18807. </method>
  18808. <method name="getCounter" return="org.apache.hadoop.mapreduce.Counter"
  18809. abstract="false" native="false" synchronized="false"
  18810. static="false" final="false" visibility="public"
  18811. deprecated="not deprecated">
  18812. <param name="counterName" type="java.lang.Enum"/>
  18813. </method>
  18814. <method name="getCounter" return="org.apache.hadoop.mapreduce.Counter"
  18815. abstract="false" native="false" synchronized="false"
  18816. static="false" final="false" visibility="public"
  18817. deprecated="not deprecated">
  18818. <param name="groupName" type="java.lang.String"/>
  18819. <param name="counterName" type="java.lang.String"/>
  18820. </method>
  18821. <method name="progress"
  18822. abstract="false" native="false" synchronized="false"
  18823. static="false" final="false" visibility="public"
  18824. deprecated="not deprecated">
  18825. </method>
  18826. <method name="setStatus"
  18827. abstract="false" native="false" synchronized="false"
  18828. static="false" final="false" visibility="public"
  18829. deprecated="not deprecated">
  18830. <param name="status" type="java.lang.String"/>
  18831. </method>
  18832. <method name="getOutputCommitter" return="org.apache.hadoop.mapreduce.OutputCommitter"
  18833. abstract="false" native="false" synchronized="false"
  18834. static="false" final="false" visibility="public"
  18835. deprecated="not deprecated">
  18836. </method>
  18837. <doc>
  18838. <![CDATA[A context object that allows input and output from the task. It is only
  18839. supplied to the {@link Mapper} or {@link Reducer}.
  18840. @param <KEYIN> the input key type for the task
  18841. @param <VALUEIN> the input value type for the task
  18842. @param <KEYOUT> the output key type for the task
  18843. @param <VALUEOUT> the output value type for the task]]>
  18844. </doc>
  18845. </class>
  18846. <!-- end class org.apache.hadoop.mapreduce.TaskInputOutputContext -->
  18847. </package>
  18848. <package name="org.apache.hadoop.mapreduce.lib.input">
  18849. <!-- start class org.apache.hadoop.mapreduce.lib.input.FileInputFormat -->
  18850. <class name="FileInputFormat" extends="org.apache.hadoop.mapreduce.InputFormat"
  18851. abstract="true"
  18852. static="false" final="false" visibility="public"
  18853. deprecated="not deprecated">
  18854. <constructor name="FileInputFormat"
  18855. static="false" final="false" visibility="public"
  18856. deprecated="not deprecated">
  18857. </constructor>
  18858. <method name="getFormatMinSplitSize" return="long"
  18859. abstract="false" native="false" synchronized="false"
  18860. static="false" final="false" visibility="protected"
  18861. deprecated="not deprecated">
  18862. <doc>
  18863. <![CDATA[Get the lower bound on split size imposed by the format.
  18864. @return the number of bytes of the minimal split for this format]]>
  18865. </doc>
  18866. </method>
  18867. <method name="isSplitable" return="boolean"
  18868. abstract="false" native="false" synchronized="false"
  18869. static="false" final="false" visibility="protected"
  18870. deprecated="not deprecated">
  18871. <param name="context" type="org.apache.hadoop.mapreduce.JobContext"/>
  18872. <param name="filename" type="org.apache.hadoop.fs.Path"/>
  18873. <doc>
  18874. <![CDATA[Is the given filename splitable? Usually, true, but if the file is
  18875. stream compressed, it will not be.
  18876. <code>FileInputFormat</code> implementations can override this and return
  18877. <code>false</code> to ensure that individual input files are never split-up
  18878. so that {@link Mapper}s process entire files.
  18879. @param context the job context
  18880. @param filename the file name to check
  18881. @return is this file splitable?]]>
  18882. </doc>
  18883. </method>
  18884. <method name="setInputPathFilter"
  18885. abstract="false" native="false" synchronized="false"
  18886. static="true" final="false" visibility="public"
  18887. deprecated="not deprecated">
  18888. <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
  18889. <param name="filter" type="java.lang.Class"/>
  18890. <doc>
  18891. <![CDATA[Set a PathFilter to be applied to the input paths for the map-reduce job.
  18892. @param job the job to modify
  18893. @param filter the PathFilter class use for filtering the input paths.]]>
  18894. </doc>
  18895. </method>
  18896. <method name="setMinInputSplitSize"
  18897. abstract="false" native="false" synchronized="false"
  18898. static="true" final="false" visibility="public"
  18899. deprecated="not deprecated">
  18900. <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
  18901. <param name="size" type="long"/>
  18902. <doc>
  18903. <![CDATA[Set the minimum input split size
  18904. @param job the job to modify
  18905. @param size the minimum size]]>
  18906. </doc>
  18907. </method>
  18908. <method name="getMinSplitSize" return="long"
  18909. abstract="false" native="false" synchronized="false"
  18910. static="true" final="false" visibility="public"
  18911. deprecated="not deprecated">
  18912. <param name="job" type="org.apache.hadoop.mapreduce.JobContext"/>
  18913. <doc>
  18914. <![CDATA[Get the minimum split size
  18915. @param job the job
  18916. @return the minimum number of bytes that can be in a split]]>
  18917. </doc>
  18918. </method>
  18919. <method name="setMaxInputSplitSize"
  18920. abstract="false" native="false" synchronized="false"
  18921. static="true" final="false" visibility="public"
  18922. deprecated="not deprecated">
  18923. <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
  18924. <param name="size" type="long"/>
  18925. <doc>
  18926. <![CDATA[Set the maximum split size
  18927. @param job the job to modify
  18928. @param size the maximum split size]]>
  18929. </doc>
  18930. </method>
  18931. <method name="getMaxSplitSize" return="long"
  18932. abstract="false" native="false" synchronized="false"
  18933. static="true" final="false" visibility="public"
  18934. deprecated="not deprecated">
  18935. <param name="context" type="org.apache.hadoop.mapreduce.JobContext"/>
  18936. <doc>
  18937. <![CDATA[Get the maximum split size.
  18938. @param context the job to look at.
  18939. @return the maximum number of bytes a split can include]]>
  18940. </doc>
  18941. </method>
  18942. <method name="getInputPathFilter" return="org.apache.hadoop.fs.PathFilter"
  18943. abstract="false" native="false" synchronized="false"
  18944. static="true" final="false" visibility="public"
  18945. deprecated="not deprecated">
  18946. <param name="context" type="org.apache.hadoop.mapreduce.JobContext"/>
  18947. <doc>
  18948. <![CDATA[Get a PathFilter instance of the filter set for the input paths.
  18949. @return the PathFilter instance set for the job, NULL if none has been set.]]>
  18950. </doc>
  18951. </method>
  18952. <method name="listStatus" return="java.util.List"
  18953. abstract="false" native="false" synchronized="false"
  18954. static="false" final="false" visibility="protected"
  18955. deprecated="not deprecated">
  18956. <param name="job" type="org.apache.hadoop.mapreduce.JobContext"/>
  18957. <exception name="IOException" type="java.io.IOException"/>
  18958. <doc>
  18959. <![CDATA[List input directories.
  18960. Subclasses may override to, e.g., select only files matching a regular
  18961. expression.
  18962. @param job the job to list input paths for
  18963. @return array of FileStatus objects
  18964. @throws IOException if zero items.]]>
  18965. </doc>
  18966. </method>
  18967. <method name="getSplits" return="java.util.List"
  18968. abstract="false" native="false" synchronized="false"
  18969. static="false" final="false" visibility="public"
  18970. deprecated="not deprecated">
  18971. <param name="job" type="org.apache.hadoop.mapreduce.JobContext"/>
  18972. <exception name="IOException" type="java.io.IOException"/>
  18973. <doc>
  18974. <![CDATA[Generate the list of files and make them into FileSplits.]]>
  18975. </doc>
  18976. </method>
  18977. <method name="computeSplitSize" return="long"
  18978. abstract="false" native="false" synchronized="false"
  18979. static="false" final="false" visibility="protected"
  18980. deprecated="not deprecated">
  18981. <param name="blockSize" type="long"/>
  18982. <param name="minSize" type="long"/>
  18983. <param name="maxSize" type="long"/>
  18984. </method>
  18985. <method name="getBlockIndex" return="int"
  18986. abstract="false" native="false" synchronized="false"
  18987. static="false" final="false" visibility="protected"
  18988. deprecated="not deprecated">
  18989. <param name="blkLocations" type="org.apache.hadoop.fs.BlockLocation[]"/>
  18990. <param name="offset" type="long"/>
  18991. </method>
  18992. <method name="setInputPaths"
  18993. abstract="false" native="false" synchronized="false"
  18994. static="true" final="false" visibility="public"
  18995. deprecated="not deprecated">
  18996. <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
  18997. <param name="commaSeparatedPaths" type="java.lang.String"/>
  18998. <exception name="IOException" type="java.io.IOException"/>
  18999. <doc>
  19000. <![CDATA[Sets the given comma separated paths as the list of inputs
  19001. for the map-reduce job.
  19002. @param job the job
  19003. @param commaSeparatedPaths Comma separated paths to be set as
  19004. the list of inputs for the map-reduce job.]]>
  19005. </doc>
  19006. </method>
  19007. <method name="addInputPaths"
  19008. abstract="false" native="false" synchronized="false"
  19009. static="true" final="false" visibility="public"
  19010. deprecated="not deprecated">
  19011. <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
  19012. <param name="commaSeparatedPaths" type="java.lang.String"/>
  19013. <exception name="IOException" type="java.io.IOException"/>
  19014. <doc>
  19015. <![CDATA[Add the given comma separated paths to the list of inputs for
  19016. the map-reduce job.
  19017. @param job The job to modify
  19018. @param commaSeparatedPaths Comma separated paths to be added to
  19019. the list of inputs for the map-reduce job.]]>
  19020. </doc>
  19021. </method>
  19022. <method name="setInputPaths"
  19023. abstract="false" native="false" synchronized="false"
  19024. static="true" final="false" visibility="public"
  19025. deprecated="not deprecated">
  19026. <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
  19027. <param name="inputPaths" type="org.apache.hadoop.fs.Path[]"/>
  19028. <exception name="IOException" type="java.io.IOException"/>
  19029. <doc>
  19030. <![CDATA[Set the array of {@link Path}s as the list of inputs
  19031. for the map-reduce job.
  19032. @param job The job to modify
  19033. @param inputPaths the {@link Path}s of the input directories/files
  19034. for the map-reduce job.]]>
  19035. </doc>
  19036. </method>
  19037. <method name="addInputPath"
  19038. abstract="false" native="false" synchronized="false"
  19039. static="true" final="false" visibility="public"
  19040. deprecated="not deprecated">
  19041. <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
  19042. <param name="path" type="org.apache.hadoop.fs.Path"/>
  19043. <exception name="IOException" type="java.io.IOException"/>
  19044. <doc>
  19045. <![CDATA[Add a {@link Path} to the list of inputs for the map-reduce job.
  19046. @param job The {@link Job} to modify
  19047. @param path {@link Path} to be added to the list of inputs for
  19048. the map-reduce job.]]>
  19049. </doc>
  19050. </method>
  19051. <method name="getInputPaths" return="org.apache.hadoop.fs.Path[]"
  19052. abstract="false" native="false" synchronized="false"
  19053. static="true" final="false" visibility="public"
  19054. deprecated="not deprecated">
  19055. <param name="context" type="org.apache.hadoop.mapreduce.JobContext"/>
  19056. <doc>
  19057. <![CDATA[Get the list of input {@link Path}s for the map-reduce job.
  19058. @param context The job
  19059. @return the list of input {@link Path}s for the map-reduce job.]]>
  19060. </doc>
  19061. </method>
  19062. <doc>
  19063. <![CDATA[A base class for file-based {@link InputFormat}s.
  19064. <p><code>FileInputFormat</code> is the base class for all file-based
  19065. <code>InputFormat</code>s. This provides a generic implementation of
  19066. {@link #getSplits(JobContext)}.
  19067. Subclasses of <code>FileInputFormat</code> can also override the
  19068. {@link #isSplitable(JobContext, Path)} method to ensure input-files are
  19069. not split-up and are processed as a whole by {@link Mapper}s.]]>
  19070. </doc>
  19071. </class>
  19072. <!-- end class org.apache.hadoop.mapreduce.lib.input.FileInputFormat -->
  19073. <!-- start class org.apache.hadoop.mapreduce.lib.input.FileSplit -->
  19074. <class name="FileSplit" extends="org.apache.hadoop.mapreduce.InputSplit"
  19075. abstract="false"
  19076. static="false" final="false" visibility="public"
  19077. deprecated="not deprecated">
  19078. <implements name="org.apache.hadoop.io.Writable"/>
  19079. <constructor name="FileSplit" type="org.apache.hadoop.fs.Path, long, long, java.lang.String[]"
  19080. static="false" final="false" visibility="public"
  19081. deprecated="not deprecated">
  19082. <doc>
  19083. <![CDATA[Constructs a split with host information
  19084. @param file the file name
  19085. @param start the position of the first byte in the file to process
  19086. @param length the number of bytes in the file to process
  19087. @param hosts the list of hosts containing the block, possibly null]]>
  19088. </doc>
  19089. </constructor>
  19090. <method name="getPath" return="org.apache.hadoop.fs.Path"
  19091. abstract="false" native="false" synchronized="false"
  19092. static="false" final="false" visibility="public"
  19093. deprecated="not deprecated">
  19094. <doc>
  19095. <![CDATA[The file containing this split's data.]]>
  19096. </doc>
  19097. </method>
  19098. <method name="getStart" return="long"
  19099. abstract="false" native="false" synchronized="false"
  19100. static="false" final="false" visibility="public"
  19101. deprecated="not deprecated">
  19102. <doc>
  19103. <![CDATA[The position of the first byte in the file to process.]]>
  19104. </doc>
  19105. </method>
  19106. <method name="getLength" return="long"
  19107. abstract="false" native="false" synchronized="false"
  19108. static="false" final="false" visibility="public"
  19109. deprecated="not deprecated">
  19110. <doc>
  19111. <![CDATA[The number of bytes in the file to process.]]>
  19112. </doc>
  19113. </method>
  19114. <method name="toString" return="java.lang.String"
  19115. abstract="false" native="false" synchronized="false"
  19116. static="false" final="false" visibility="public"
  19117. deprecated="not deprecated">
  19118. </method>
  19119. <method name="write"
  19120. abstract="false" native="false" synchronized="false"
  19121. static="false" final="false" visibility="public"
  19122. deprecated="not deprecated">
  19123. <param name="out" type="java.io.DataOutput"/>
  19124. <exception name="IOException" type="java.io.IOException"/>
  19125. </method>
  19126. <method name="readFields"
  19127. abstract="false" native="false" synchronized="false"
  19128. static="false" final="false" visibility="public"
  19129. deprecated="not deprecated">
  19130. <param name="in" type="java.io.DataInput"/>
  19131. <exception name="IOException" type="java.io.IOException"/>
  19132. </method>
  19133. <method name="getLocations" return="java.lang.String[]"
  19134. abstract="false" native="false" synchronized="false"
  19135. static="false" final="false" visibility="public"
  19136. deprecated="not deprecated">
  19137. <exception name="IOException" type="java.io.IOException"/>
  19138. </method>
  19139. <doc>
  19140. <![CDATA[A section of an input file. Returned by {@link
  19141. InputFormat#getSplits(JobContext)} and passed to
  19142. {@link InputFormat#createRecordReader(InputSplit,TaskAttemptContext)}.]]>
  19143. </doc>
  19144. </class>
  19145. <!-- end class org.apache.hadoop.mapreduce.lib.input.FileSplit -->
  19146. <!-- start class org.apache.hadoop.mapreduce.lib.input.InvalidInputException -->
  19147. <class name="InvalidInputException" extends="java.io.IOException"
  19148. abstract="false"
  19149. static="false" final="false" visibility="public"
  19150. deprecated="not deprecated">
  19151. <constructor name="InvalidInputException" type="java.util.List"
  19152. static="false" final="false" visibility="public"
  19153. deprecated="not deprecated">
  19154. <doc>
  19155. <![CDATA[Create the exception with the given list.
  19156. @param probs the list of problems to report. this list is not copied.]]>
  19157. </doc>
  19158. </constructor>
  19159. <method name="getProblems" return="java.util.List"
  19160. abstract="false" native="false" synchronized="false"
  19161. static="false" final="false" visibility="public"
  19162. deprecated="not deprecated">
  19163. <doc>
  19164. <![CDATA[Get the complete list of the problems reported.
  19165. @return the list of problems, which must not be modified]]>
  19166. </doc>
  19167. </method>
  19168. <method name="getMessage" return="java.lang.String"
  19169. abstract="false" native="false" synchronized="false"
  19170. static="false" final="false" visibility="public"
  19171. deprecated="not deprecated">
  19172. <doc>
  19173. <![CDATA[Get a summary message of the problems found.
  19174. @return the concatenated messages from all of the problems.]]>
  19175. </doc>
  19176. </method>
  19177. <doc>
  19178. <![CDATA[This class wraps a list of problems with the input, so that the user
  19179. can get a list of problems together instead of finding and fixing them one
  19180. by one.]]>
  19181. </doc>
  19182. </class>
  19183. <!-- end class org.apache.hadoop.mapreduce.lib.input.InvalidInputException -->
  19184. <!-- start class org.apache.hadoop.mapreduce.lib.input.LineRecordReader -->
  19185. <class name="LineRecordReader" extends="org.apache.hadoop.mapreduce.RecordReader"
  19186. abstract="false"
  19187. static="false" final="false" visibility="public"
  19188. deprecated="not deprecated">
  19189. <constructor name="LineRecordReader"
  19190. static="false" final="false" visibility="public"
  19191. deprecated="not deprecated">
  19192. </constructor>
  19193. <method name="initialize"
  19194. abstract="false" native="false" synchronized="false"
  19195. static="false" final="false" visibility="public"
  19196. deprecated="not deprecated">
  19197. <param name="genericSplit" type="org.apache.hadoop.mapreduce.InputSplit"/>
  19198. <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
  19199. <exception name="IOException" type="java.io.IOException"/>
  19200. </method>
  19201. <method name="nextKeyValue" return="boolean"
  19202. abstract="false" native="false" synchronized="false"
  19203. static="false" final="false" visibility="public"
  19204. deprecated="not deprecated">
  19205. <exception name="IOException" type="java.io.IOException"/>
  19206. </method>
  19207. <method name="getCurrentKey" return="org.apache.hadoop.io.LongWritable"
  19208. abstract="false" native="false" synchronized="false"
  19209. static="false" final="false" visibility="public"
  19210. deprecated="not deprecated">
  19211. </method>
  19212. <method name="getCurrentValue" return="org.apache.hadoop.io.Text"
  19213. abstract="false" native="false" synchronized="false"
  19214. static="false" final="false" visibility="public"
  19215. deprecated="not deprecated">
  19216. </method>
  19217. <method name="getProgress" return="float"
  19218. abstract="false" native="false" synchronized="false"
  19219. static="false" final="false" visibility="public"
  19220. deprecated="not deprecated">
  19221. <doc>
  19222. <![CDATA[Get the progress within the split]]>
  19223. </doc>
  19224. </method>
  19225. <method name="close"
  19226. abstract="false" native="false" synchronized="true"
  19227. static="false" final="false" visibility="public"
  19228. deprecated="not deprecated">
  19229. <exception name="IOException" type="java.io.IOException"/>
  19230. </method>
  19231. <doc>
  19232. <![CDATA[Treats keys as offset in file and value as line.]]>
  19233. </doc>
  19234. </class>
  19235. <!-- end class org.apache.hadoop.mapreduce.lib.input.LineRecordReader -->
  19236. <!-- start class org.apache.hadoop.mapreduce.lib.input.SequenceFileInputFormat -->
  19237. <class name="SequenceFileInputFormat" extends="org.apache.hadoop.mapreduce.lib.input.FileInputFormat"
  19238. abstract="false"
  19239. static="false" final="false" visibility="public"
  19240. deprecated="not deprecated">
  19241. <constructor name="SequenceFileInputFormat"
  19242. static="false" final="false" visibility="public"
  19243. deprecated="not deprecated">
  19244. </constructor>
  19245. <method name="createRecordReader" return="org.apache.hadoop.mapreduce.RecordReader"
  19246. abstract="false" native="false" synchronized="false"
  19247. static="false" final="false" visibility="public"
  19248. deprecated="not deprecated">
  19249. <param name="split" type="org.apache.hadoop.mapreduce.InputSplit"/>
  19250. <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
  19251. <exception name="IOException" type="java.io.IOException"/>
  19252. </method>
  19253. <method name="getFormatMinSplitSize" return="long"
  19254. abstract="false" native="false" synchronized="false"
  19255. static="false" final="false" visibility="protected"
  19256. deprecated="not deprecated">
  19257. </method>
  19258. <method name="listStatus" return="java.util.List"
  19259. abstract="false" native="false" synchronized="false"
  19260. static="false" final="false" visibility="protected"
  19261. deprecated="not deprecated">
  19262. <param name="job" type="org.apache.hadoop.mapreduce.JobContext"/>
  19263. <exception name="IOException" type="java.io.IOException"/>
  19264. </method>
  19265. <doc>
  19266. <![CDATA[An {@link InputFormat} for {@link SequenceFile}s.]]>
  19267. </doc>
  19268. </class>
  19269. <!-- end class org.apache.hadoop.mapreduce.lib.input.SequenceFileInputFormat -->
  19270. <!-- start class org.apache.hadoop.mapreduce.lib.input.SequenceFileRecordReader -->
  19271. <class name="SequenceFileRecordReader" extends="org.apache.hadoop.mapreduce.RecordReader"
  19272. abstract="false"
  19273. static="false" final="false" visibility="public"
  19274. deprecated="not deprecated">
  19275. <constructor name="SequenceFileRecordReader"
  19276. static="false" final="false" visibility="public"
  19277. deprecated="not deprecated">
  19278. </constructor>
  19279. <method name="initialize"
  19280. abstract="false" native="false" synchronized="false"
  19281. static="false" final="false" visibility="public"
  19282. deprecated="not deprecated">
  19283. <param name="split" type="org.apache.hadoop.mapreduce.InputSplit"/>
  19284. <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
  19285. <exception name="IOException" type="java.io.IOException"/>
  19286. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  19287. </method>
  19288. <method name="nextKeyValue" return="boolean"
  19289. abstract="false" native="false" synchronized="false"
  19290. static="false" final="false" visibility="public"
  19291. deprecated="not deprecated">
  19292. <exception name="IOException" type="java.io.IOException"/>
  19293. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  19294. </method>
  19295. <method name="getCurrentKey" return="java.lang.Object"
  19296. abstract="false" native="false" synchronized="false"
  19297. static="false" final="false" visibility="public"
  19298. deprecated="not deprecated">
  19299. </method>
  19300. <method name="getCurrentValue" return="java.lang.Object"
  19301. abstract="false" native="false" synchronized="false"
  19302. static="false" final="false" visibility="public"
  19303. deprecated="not deprecated">
  19304. </method>
  19305. <method name="getProgress" return="float"
  19306. abstract="false" native="false" synchronized="false"
  19307. static="false" final="false" visibility="public"
  19308. deprecated="not deprecated">
  19309. <exception name="IOException" type="java.io.IOException"/>
  19310. <doc>
  19311. <![CDATA[Return the progress within the input split
  19312. @return 0.0 to 1.0 of the input byte range]]>
  19313. </doc>
  19314. </method>
  19315. <method name="close"
  19316. abstract="false" native="false" synchronized="true"
  19317. static="false" final="false" visibility="public"
  19318. deprecated="not deprecated">
  19319. <exception name="IOException" type="java.io.IOException"/>
  19320. </method>
  19321. <field name="conf" type="org.apache.hadoop.conf.Configuration"
  19322. transient="false" volatile="false"
  19323. static="false" final="false" visibility="protected"
  19324. deprecated="not deprecated">
  19325. </field>
  19326. <doc>
  19327. <![CDATA[An {@link RecordReader} for {@link SequenceFile}s.]]>
  19328. </doc>
  19329. </class>
  19330. <!-- end class org.apache.hadoop.mapreduce.lib.input.SequenceFileRecordReader -->
  19331. <!-- start class org.apache.hadoop.mapreduce.lib.input.TextInputFormat -->
  19332. <class name="TextInputFormat" extends="org.apache.hadoop.mapreduce.lib.input.FileInputFormat"
  19333. abstract="false"
  19334. static="false" final="false" visibility="public"
  19335. deprecated="not deprecated">
  19336. <constructor name="TextInputFormat"
  19337. static="false" final="false" visibility="public"
  19338. deprecated="not deprecated">
  19339. </constructor>
  19340. <method name="createRecordReader" return="org.apache.hadoop.mapreduce.RecordReader"
  19341. abstract="false" native="false" synchronized="false"
  19342. static="false" final="false" visibility="public"
  19343. deprecated="not deprecated">
  19344. <param name="split" type="org.apache.hadoop.mapreduce.InputSplit"/>
  19345. <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
  19346. </method>
  19347. <method name="isSplitable" return="boolean"
  19348. abstract="false" native="false" synchronized="false"
  19349. static="false" final="false" visibility="protected"
  19350. deprecated="not deprecated">
  19351. <param name="context" type="org.apache.hadoop.mapreduce.JobContext"/>
  19352. <param name="file" type="org.apache.hadoop.fs.Path"/>
  19353. </method>
  19354. <doc>
  19355. <![CDATA[An {@link InputFormat} for plain text files. Files are broken into lines.
  19356. Either linefeed or carriage-return are used to signal end of line. Keys are
  19357. the position in the file, and values are the line of text..]]>
  19358. </doc>
  19359. </class>
  19360. <!-- end class org.apache.hadoop.mapreduce.lib.input.TextInputFormat -->
  19361. </package>
  19362. <package name="org.apache.hadoop.mapreduce.lib.map">
  19363. <!-- start class org.apache.hadoop.mapreduce.lib.map.InverseMapper -->
  19364. <class name="InverseMapper" extends="org.apache.hadoop.mapreduce.Mapper"
  19365. abstract="false"
  19366. static="false" final="false" visibility="public"
  19367. deprecated="not deprecated">
  19368. <constructor name="InverseMapper"
  19369. static="false" final="false" visibility="public"
  19370. deprecated="not deprecated">
  19371. </constructor>
  19372. <method name="map"
  19373. abstract="false" native="false" synchronized="false"
  19374. static="false" final="false" visibility="public"
  19375. deprecated="not deprecated">
  19376. <param name="key" type="java.lang.Object"/>
  19377. <param name="value" type="java.lang.Object"/>
  19378. <param name="context" type="org.apache.hadoop.mapreduce.Mapper.Context"/>
  19379. <exception name="IOException" type="java.io.IOException"/>
  19380. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  19381. <doc>
  19382. <![CDATA[The inverse function. Input keys and values are swapped.]]>
  19383. </doc>
  19384. </method>
  19385. <doc>
  19386. <![CDATA[A {@link Mapper} that swaps keys and values.]]>
  19387. </doc>
  19388. </class>
  19389. <!-- end class org.apache.hadoop.mapreduce.lib.map.InverseMapper -->
  19390. <!-- start class org.apache.hadoop.mapreduce.lib.map.MultithreadedMapper -->
  19391. <class name="MultithreadedMapper" extends="org.apache.hadoop.mapreduce.Mapper"
  19392. abstract="false"
  19393. static="false" final="false" visibility="public"
  19394. deprecated="not deprecated">
  19395. <constructor name="MultithreadedMapper"
  19396. static="false" final="false" visibility="public"
  19397. deprecated="not deprecated">
  19398. </constructor>
  19399. <method name="getNumberOfThreads" return="int"
  19400. abstract="false" native="false" synchronized="false"
  19401. static="true" final="false" visibility="public"
  19402. deprecated="not deprecated">
  19403. <param name="job" type="org.apache.hadoop.mapreduce.JobContext"/>
  19404. <doc>
  19405. <![CDATA[The number of threads in the thread pool that will run the map function.
  19406. @param job the job
  19407. @return the number of threads]]>
  19408. </doc>
  19409. </method>
  19410. <method name="setNumberOfThreads"
  19411. abstract="false" native="false" synchronized="false"
  19412. static="true" final="false" visibility="public"
  19413. deprecated="not deprecated">
  19414. <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
  19415. <param name="threads" type="int"/>
  19416. <doc>
  19417. <![CDATA[Set the number of threads in the pool for running maps.
  19418. @param job the job to modify
  19419. @param threads the new number of threads]]>
  19420. </doc>
  19421. </method>
  19422. <method name="getMapperClass" return="java.lang.Class"
  19423. abstract="false" native="false" synchronized="false"
  19424. static="true" final="false" visibility="public"
  19425. deprecated="not deprecated">
  19426. <param name="job" type="org.apache.hadoop.mapreduce.JobContext"/>
  19427. <doc>
  19428. <![CDATA[Get the application's mapper class.
  19429. @param <K1> the map's input key type
  19430. @param <V1> the map's input value type
  19431. @param <K2> the map's output key type
  19432. @param <V2> the map's output value type
  19433. @param job the job
  19434. @return the mapper class to run]]>
  19435. </doc>
  19436. </method>
  19437. <method name="setMapperClass"
  19438. abstract="false" native="false" synchronized="false"
  19439. static="true" final="false" visibility="public"
  19440. deprecated="not deprecated">
  19441. <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
  19442. <param name="cls" type="java.lang.Class"/>
  19443. <doc>
  19444. <![CDATA[Set the application's mapper class.
  19445. @param <K1> the map input key type
  19446. @param <V1> the map input value type
  19447. @param <K2> the map output key type
  19448. @param <V2> the map output value type
  19449. @param job the job to modify
  19450. @param cls the class to use as the mapper]]>
  19451. </doc>
  19452. </method>
  19453. <method name="run"
  19454. abstract="false" native="false" synchronized="false"
  19455. static="false" final="false" visibility="public"
  19456. deprecated="not deprecated">
  19457. <param name="context" type="org.apache.hadoop.mapreduce.Mapper.Context"/>
  19458. <exception name="IOException" type="java.io.IOException"/>
  19459. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  19460. <doc>
  19461. <![CDATA[Run the application's maps using a thread pool.]]>
  19462. </doc>
  19463. </method>
  19464. <doc>
  19465. <![CDATA[Multithreaded implementation for @link org.apache.hadoop.mapreduce.Mapper.
  19466. <p>
  19467. It can be used instead of the default implementation,
  19468. @link org.apache.hadoop.mapred.MapRunner, when the Map operation is not CPU
  19469. bound in order to improve throughput.
  19470. <p>
  19471. Mapper implementations using this MapRunnable must be thread-safe.
  19472. <p>
  19473. The Map-Reduce job has to be configured with the mapper to use via
  19474. {@link #setMapperClass(Configuration, Class)} and
  19475. the number of thread the thread-pool can use with the
  19476. {@link #getNumberOfThreads(Configuration) method. The default
  19477. value is 10 threads.
  19478. <p>]]>
  19479. </doc>
  19480. </class>
  19481. <!-- end class org.apache.hadoop.mapreduce.lib.map.MultithreadedMapper -->
  19482. <!-- start class org.apache.hadoop.mapreduce.lib.map.TokenCounterMapper -->
  19483. <class name="TokenCounterMapper" extends="org.apache.hadoop.mapreduce.Mapper"
  19484. abstract="false"
  19485. static="false" final="false" visibility="public"
  19486. deprecated="not deprecated">
  19487. <constructor name="TokenCounterMapper"
  19488. static="false" final="false" visibility="public"
  19489. deprecated="not deprecated">
  19490. </constructor>
  19491. <method name="map"
  19492. abstract="false" native="false" synchronized="false"
  19493. static="false" final="false" visibility="public"
  19494. deprecated="not deprecated">
  19495. <param name="key" type="java.lang.Object"/>
  19496. <param name="value" type="org.apache.hadoop.io.Text"/>
  19497. <param name="context" type="org.apache.hadoop.mapreduce.Mapper.Context"/>
  19498. <exception name="IOException" type="java.io.IOException"/>
  19499. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  19500. </method>
  19501. <doc>
  19502. <![CDATA[Tokenize the input values and emit each word with a count of 1.]]>
  19503. </doc>
  19504. </class>
  19505. <!-- end class org.apache.hadoop.mapreduce.lib.map.TokenCounterMapper -->
  19506. </package>
  19507. <package name="org.apache.hadoop.mapreduce.lib.output">
  19508. <!-- start class org.apache.hadoop.mapreduce.lib.output.FileOutputCommitter -->
  19509. <class name="FileOutputCommitter" extends="org.apache.hadoop.mapreduce.OutputCommitter"
  19510. abstract="false"
  19511. static="false" final="false" visibility="public"
  19512. deprecated="not deprecated">
  19513. <constructor name="FileOutputCommitter" type="org.apache.hadoop.fs.Path, org.apache.hadoop.mapreduce.TaskAttemptContext"
  19514. static="false" final="false" visibility="public"
  19515. deprecated="not deprecated">
  19516. <exception name="IOException" type="java.io.IOException"/>
  19517. <doc>
  19518. <![CDATA[Create a file output committer
  19519. @param outputPath the job's output path
  19520. @param context the task's context
  19521. @throws IOException]]>
  19522. </doc>
  19523. </constructor>
  19524. <method name="setupJob"
  19525. abstract="false" native="false" synchronized="false"
  19526. static="false" final="false" visibility="public"
  19527. deprecated="not deprecated">
  19528. <param name="context" type="org.apache.hadoop.mapreduce.JobContext"/>
  19529. <exception name="IOException" type="java.io.IOException"/>
  19530. <doc>
  19531. <![CDATA[Create the temporary directory that is the root of all of the task
  19532. work directories.
  19533. @param context the job's context]]>
  19534. </doc>
  19535. </method>
  19536. <method name="cleanupJob"
  19537. abstract="false" native="false" synchronized="false"
  19538. static="false" final="false" visibility="public"
  19539. deprecated="not deprecated">
  19540. <param name="context" type="org.apache.hadoop.mapreduce.JobContext"/>
  19541. <exception name="IOException" type="java.io.IOException"/>
  19542. <doc>
  19543. <![CDATA[Delete the temporary directory, including all of the work directories.
  19544. @param context the job's context]]>
  19545. </doc>
  19546. </method>
  19547. <method name="setupTask"
  19548. abstract="false" native="false" synchronized="false"
  19549. static="false" final="false" visibility="public"
  19550. deprecated="not deprecated">
  19551. <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
  19552. <exception name="IOException" type="java.io.IOException"/>
  19553. <doc>
  19554. <![CDATA[No task setup required.]]>
  19555. </doc>
  19556. </method>
  19557. <method name="commitTask"
  19558. abstract="false" native="false" synchronized="false"
  19559. static="false" final="false" visibility="public"
  19560. deprecated="not deprecated">
  19561. <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
  19562. <exception name="IOException" type="java.io.IOException"/>
  19563. <doc>
  19564. <![CDATA[Move the files from the work directory to the job output directory
  19565. @param context the task context]]>
  19566. </doc>
  19567. </method>
  19568. <method name="abortTask"
  19569. abstract="false" native="false" synchronized="false"
  19570. static="false" final="false" visibility="public"
  19571. deprecated="not deprecated">
  19572. <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
  19573. <doc>
  19574. <![CDATA[Delete the work directory]]>
  19575. </doc>
  19576. </method>
  19577. <method name="needsTaskCommit" return="boolean"
  19578. abstract="false" native="false" synchronized="false"
  19579. static="false" final="false" visibility="public"
  19580. deprecated="not deprecated">
  19581. <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
  19582. <exception name="IOException" type="java.io.IOException"/>
  19583. <doc>
  19584. <![CDATA[Did this task write any files in the work directory?
  19585. @param context the task's context]]>
  19586. </doc>
  19587. </method>
  19588. <method name="getWorkPath" return="org.apache.hadoop.fs.Path"
  19589. abstract="false" native="false" synchronized="false"
  19590. static="false" final="false" visibility="public"
  19591. deprecated="not deprecated">
  19592. <exception name="IOException" type="java.io.IOException"/>
  19593. <doc>
  19594. <![CDATA[Get the directory that the task should write results into
  19595. @return the work directory
  19596. @throws IOException]]>
  19597. </doc>
  19598. </method>
  19599. <field name="TEMP_DIR_NAME" type="java.lang.String"
  19600. transient="false" volatile="false"
  19601. static="true" final="true" visibility="protected"
  19602. deprecated="not deprecated">
  19603. <doc>
  19604. <![CDATA[Temporary directory name]]>
  19605. </doc>
  19606. </field>
  19607. <doc>
  19608. <![CDATA[An {@link OutputCommitter} that commits files specified
  19609. in job output directory i.e. ${mapred.output.dir}.]]>
  19610. </doc>
  19611. </class>
  19612. <!-- end class org.apache.hadoop.mapreduce.lib.output.FileOutputCommitter -->
  19613. <!-- start class org.apache.hadoop.mapreduce.lib.output.FileOutputFormat -->
  19614. <class name="FileOutputFormat" extends="org.apache.hadoop.mapreduce.OutputFormat"
  19615. abstract="true"
  19616. static="false" final="false" visibility="public"
  19617. deprecated="not deprecated">
  19618. <constructor name="FileOutputFormat"
  19619. static="false" final="false" visibility="public"
  19620. deprecated="not deprecated">
  19621. </constructor>
  19622. <method name="setCompressOutput"
  19623. abstract="false" native="false" synchronized="false"
  19624. static="true" final="false" visibility="public"
  19625. deprecated="not deprecated">
  19626. <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
  19627. <param name="compress" type="boolean"/>
  19628. <doc>
  19629. <![CDATA[Set whether the output of the job is compressed.
  19630. @param job the job to modify
  19631. @param compress should the output of the job be compressed?]]>
  19632. </doc>
  19633. </method>
  19634. <method name="getCompressOutput" return="boolean"
  19635. abstract="false" native="false" synchronized="false"
  19636. static="true" final="false" visibility="public"
  19637. deprecated="not deprecated">
  19638. <param name="job" type="org.apache.hadoop.mapreduce.JobContext"/>
  19639. <doc>
  19640. <![CDATA[Is the job output compressed?
  19641. @param job the Job to look in
  19642. @return <code>true</code> if the job output should be compressed,
  19643. <code>false</code> otherwise]]>
  19644. </doc>
  19645. </method>
  19646. <method name="setOutputCompressorClass"
  19647. abstract="false" native="false" synchronized="false"
  19648. static="true" final="false" visibility="public"
  19649. deprecated="not deprecated">
  19650. <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
  19651. <param name="codecClass" type="java.lang.Class"/>
  19652. <doc>
  19653. <![CDATA[Set the {@link CompressionCodec} to be used to compress job outputs.
  19654. @param job the job to modify
  19655. @param codecClass the {@link CompressionCodec} to be used to
  19656. compress the job outputs]]>
  19657. </doc>
  19658. </method>
  19659. <method name="getOutputCompressorClass" return="java.lang.Class"
  19660. abstract="false" native="false" synchronized="false"
  19661. static="true" final="false" visibility="public"
  19662. deprecated="not deprecated">
  19663. <param name="job" type="org.apache.hadoop.mapreduce.JobContext"/>
  19664. <param name="defaultValue" type="java.lang.Class"/>
  19665. <doc>
  19666. <![CDATA[Get the {@link CompressionCodec} for compressing the job outputs.
  19667. @param job the {@link Job} to look in
  19668. @param defaultValue the {@link CompressionCodec} to return if not set
  19669. @return the {@link CompressionCodec} to be used to compress the
  19670. job outputs
  19671. @throws IllegalArgumentException if the class was specified, but not found]]>
  19672. </doc>
  19673. </method>
  19674. <method name="getRecordWriter" return="org.apache.hadoop.mapreduce.RecordWriter"
  19675. abstract="true" native="false" synchronized="false"
  19676. static="false" final="false" visibility="public"
  19677. deprecated="not deprecated">
  19678. <param name="job" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
  19679. <exception name="IOException" type="java.io.IOException"/>
  19680. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  19681. </method>
  19682. <method name="checkOutputSpecs"
  19683. abstract="false" native="false" synchronized="false"
  19684. static="false" final="false" visibility="public"
  19685. deprecated="not deprecated">
  19686. <param name="job" type="org.apache.hadoop.mapreduce.JobContext"/>
  19687. <exception name="FileAlreadyExistsException" type="org.apache.hadoop.mapred.FileAlreadyExistsException"/>
  19688. <exception name="IOException" type="java.io.IOException"/>
  19689. </method>
  19690. <method name="setOutputPath"
  19691. abstract="false" native="false" synchronized="false"
  19692. static="true" final="false" visibility="public"
  19693. deprecated="not deprecated">
  19694. <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
  19695. <param name="outputDir" type="org.apache.hadoop.fs.Path"/>
  19696. <doc>
  19697. <![CDATA[Set the {@link Path} of the output directory for the map-reduce job.
  19698. @param job The job to modify
  19699. @param outputDir the {@link Path} of the output directory for
  19700. the map-reduce job.]]>
  19701. </doc>
  19702. </method>
  19703. <method name="getOutputPath" return="org.apache.hadoop.fs.Path"
  19704. abstract="false" native="false" synchronized="false"
  19705. static="true" final="false" visibility="public"
  19706. deprecated="not deprecated">
  19707. <param name="job" type="org.apache.hadoop.mapreduce.JobContext"/>
  19708. <doc>
  19709. <![CDATA[Get the {@link Path} to the output directory for the map-reduce job.
  19710. @return the {@link Path} to the output directory for the map-reduce job.
  19711. @see FileOutputFormat#getWorkOutputPath(TaskInputOutputContext)]]>
  19712. </doc>
  19713. </method>
  19714. <method name="getWorkOutputPath" return="org.apache.hadoop.fs.Path"
  19715. abstract="false" native="false" synchronized="false"
  19716. static="true" final="false" visibility="public"
  19717. deprecated="not deprecated">
  19718. <param name="context" type="org.apache.hadoop.mapreduce.TaskInputOutputContext"/>
  19719. <exception name="IOException" type="java.io.IOException"/>
  19720. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  19721. <doc>
  19722. <![CDATA[Get the {@link Path} to the task's temporary output directory
  19723. for the map-reduce job
  19724. <h4 id="SideEffectFiles">Tasks' Side-Effect Files</h4>
  19725. <p>Some applications need to create/write-to side-files, which differ from
  19726. the actual job-outputs.
  19727. <p>In such cases there could be issues with 2 instances of the same TIP
  19728. (running simultaneously e.g. speculative tasks) trying to open/write-to the
  19729. same file (path) on HDFS. Hence the application-writer will have to pick
  19730. unique names per task-attempt (e.g. using the attemptid, say
  19731. <tt>attempt_200709221812_0001_m_000000_0</tt>), not just per TIP.</p>
  19732. <p>To get around this the Map-Reduce framework helps the application-writer
  19733. out by maintaining a special
  19734. <tt>${mapred.output.dir}/_temporary/_${taskid}</tt>
  19735. sub-directory for each task-attempt on HDFS where the output of the
  19736. task-attempt goes. On successful completion of the task-attempt the files
  19737. in the <tt>${mapred.output.dir}/_temporary/_${taskid}</tt> (only)
  19738. are <i>promoted</i> to <tt>${mapred.output.dir}</tt>. Of course, the
  19739. framework discards the sub-directory of unsuccessful task-attempts. This
  19740. is completely transparent to the application.</p>
  19741. <p>The application-writer can take advantage of this by creating any
  19742. side-files required in a work directory during execution
  19743. of his task i.e. via
  19744. {@link #getWorkOutputPath(TaskInputOutputContext)}, and
  19745. the framework will move them out similarly - thus she doesn't have to pick
  19746. unique paths per task-attempt.</p>
  19747. <p>The entire discussion holds true for maps of jobs with
  19748. reducer=NONE (i.e. 0 reduces) since output of the map, in that case,
  19749. goes directly to HDFS.</p>
  19750. @return the {@link Path} to the task's temporary output directory
  19751. for the map-reduce job.]]>
  19752. </doc>
  19753. </method>
  19754. <method name="getPathForWorkFile" return="org.apache.hadoop.fs.Path"
  19755. abstract="false" native="false" synchronized="false"
  19756. static="true" final="false" visibility="public"
  19757. deprecated="not deprecated">
  19758. <param name="context" type="org.apache.hadoop.mapreduce.TaskInputOutputContext"/>
  19759. <param name="name" type="java.lang.String"/>
  19760. <param name="extension" type="java.lang.String"/>
  19761. <exception name="IOException" type="java.io.IOException"/>
  19762. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  19763. <doc>
  19764. <![CDATA[Helper function to generate a {@link Path} for a file that is unique for
  19765. the task within the job output directory.
  19766. <p>The path can be used to create custom files from within the map and
  19767. reduce tasks. The path name will be unique for each task. The path parent
  19768. will be the job output directory.</p>ls
  19769. <p>This method uses the {@link #getUniqueFile} method to make the file name
  19770. unique for the task.</p>
  19771. @param context the context for the task.
  19772. @param name the name for the file.
  19773. @param extension the extension for the file
  19774. @return a unique path accross all tasks of the job.]]>
  19775. </doc>
  19776. </method>
  19777. <method name="getUniqueFile" return="java.lang.String"
  19778. abstract="false" native="false" synchronized="true"
  19779. static="true" final="false" visibility="public"
  19780. deprecated="not deprecated">
  19781. <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
  19782. <param name="name" type="java.lang.String"/>
  19783. <param name="extension" type="java.lang.String"/>
  19784. <doc>
  19785. <![CDATA[Generate a unique filename, based on the task id, name, and extension
  19786. @param context the task that is calling this
  19787. @param name the base filename
  19788. @param extension the filename extension
  19789. @return a string like $name-[mr]-$id$extension]]>
  19790. </doc>
  19791. </method>
  19792. <method name="getDefaultWorkFile" return="org.apache.hadoop.fs.Path"
  19793. abstract="false" native="false" synchronized="false"
  19794. static="false" final="false" visibility="public"
  19795. deprecated="not deprecated">
  19796. <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
  19797. <param name="extension" type="java.lang.String"/>
  19798. <exception name="IOException" type="java.io.IOException"/>
  19799. <doc>
  19800. <![CDATA[Get the default path and filename for the output format.
  19801. @param context the task context
  19802. @param extension an extension to add to the filename
  19803. @return a full path $output/_temporary/$taskid/part-[mr]-$id
  19804. @throws IOException]]>
  19805. </doc>
  19806. </method>
  19807. <method name="getOutputCommitter" return="org.apache.hadoop.mapreduce.OutputCommitter"
  19808. abstract="false" native="false" synchronized="true"
  19809. static="false" final="false" visibility="public"
  19810. deprecated="not deprecated">
  19811. <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
  19812. <exception name="IOException" type="java.io.IOException"/>
  19813. </method>
  19814. <doc>
  19815. <![CDATA[A base class for {@link OutputFormat}s that read from {@link FileSystem}s.]]>
  19816. </doc>
  19817. </class>
  19818. <!-- end class org.apache.hadoop.mapreduce.lib.output.FileOutputFormat -->
  19819. <!-- start class org.apache.hadoop.mapreduce.lib.output.NullOutputFormat -->
  19820. <class name="NullOutputFormat" extends="org.apache.hadoop.mapreduce.OutputFormat"
  19821. abstract="false"
  19822. static="false" final="false" visibility="public"
  19823. deprecated="not deprecated">
  19824. <constructor name="NullOutputFormat"
  19825. static="false" final="false" visibility="public"
  19826. deprecated="not deprecated">
  19827. </constructor>
  19828. <method name="getRecordWriter" return="org.apache.hadoop.mapreduce.RecordWriter"
  19829. abstract="false" native="false" synchronized="false"
  19830. static="false" final="false" visibility="public"
  19831. deprecated="not deprecated">
  19832. <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
  19833. </method>
  19834. <method name="checkOutputSpecs"
  19835. abstract="false" native="false" synchronized="false"
  19836. static="false" final="false" visibility="public"
  19837. deprecated="not deprecated">
  19838. <param name="context" type="org.apache.hadoop.mapreduce.JobContext"/>
  19839. </method>
  19840. <method name="getOutputCommitter" return="org.apache.hadoop.mapreduce.OutputCommitter"
  19841. abstract="false" native="false" synchronized="false"
  19842. static="false" final="false" visibility="public"
  19843. deprecated="not deprecated">
  19844. <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
  19845. </method>
  19846. <doc>
  19847. <![CDATA[Consume all outputs and put them in /dev/null.]]>
  19848. </doc>
  19849. </class>
  19850. <!-- end class org.apache.hadoop.mapreduce.lib.output.NullOutputFormat -->
  19851. <!-- start class org.apache.hadoop.mapreduce.lib.output.SequenceFileOutputFormat -->
  19852. <class name="SequenceFileOutputFormat" extends="org.apache.hadoop.mapreduce.lib.output.FileOutputFormat"
  19853. abstract="false"
  19854. static="false" final="false" visibility="public"
  19855. deprecated="not deprecated">
  19856. <constructor name="SequenceFileOutputFormat"
  19857. static="false" final="false" visibility="public"
  19858. deprecated="not deprecated">
  19859. </constructor>
  19860. <method name="getRecordWriter" return="org.apache.hadoop.mapreduce.RecordWriter"
  19861. abstract="false" native="false" synchronized="false"
  19862. static="false" final="false" visibility="public"
  19863. deprecated="not deprecated">
  19864. <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
  19865. <exception name="IOException" type="java.io.IOException"/>
  19866. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  19867. </method>
  19868. <method name="getOutputCompressionType" return="org.apache.hadoop.io.SequenceFile.CompressionType"
  19869. abstract="false" native="false" synchronized="false"
  19870. static="true" final="false" visibility="public"
  19871. deprecated="not deprecated">
  19872. <param name="job" type="org.apache.hadoop.mapreduce.JobContext"/>
  19873. <doc>
  19874. <![CDATA[Get the {@link CompressionType} for the output {@link SequenceFile}.
  19875. @param job the {@link Job}
  19876. @return the {@link CompressionType} for the output {@link SequenceFile},
  19877. defaulting to {@link CompressionType#RECORD}]]>
  19878. </doc>
  19879. </method>
  19880. <method name="setOutputCompressionType"
  19881. abstract="false" native="false" synchronized="false"
  19882. static="true" final="false" visibility="public"
  19883. deprecated="not deprecated">
  19884. <param name="job" type="org.apache.hadoop.mapreduce.Job"/>
  19885. <param name="style" type="org.apache.hadoop.io.SequenceFile.CompressionType"/>
  19886. <doc>
  19887. <![CDATA[Set the {@link CompressionType} for the output {@link SequenceFile}.
  19888. @param job the {@link Job} to modify
  19889. @param style the {@link CompressionType} for the output
  19890. {@link SequenceFile}]]>
  19891. </doc>
  19892. </method>
  19893. <doc>
  19894. <![CDATA[An {@link OutputFormat} that writes {@link SequenceFile}s.]]>
  19895. </doc>
  19896. </class>
  19897. <!-- end class org.apache.hadoop.mapreduce.lib.output.SequenceFileOutputFormat -->
  19898. <!-- start class org.apache.hadoop.mapreduce.lib.output.TextOutputFormat -->
  19899. <class name="TextOutputFormat" extends="org.apache.hadoop.mapreduce.lib.output.FileOutputFormat"
  19900. abstract="false"
  19901. static="false" final="false" visibility="public"
  19902. deprecated="not deprecated">
  19903. <constructor name="TextOutputFormat"
  19904. static="false" final="false" visibility="public"
  19905. deprecated="not deprecated">
  19906. </constructor>
  19907. <method name="getRecordWriter" return="org.apache.hadoop.mapreduce.RecordWriter"
  19908. abstract="false" native="false" synchronized="false"
  19909. static="false" final="false" visibility="public"
  19910. deprecated="not deprecated">
  19911. <param name="job" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
  19912. <exception name="IOException" type="java.io.IOException"/>
  19913. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  19914. </method>
  19915. <doc>
  19916. <![CDATA[An {@link OutputFormat} that writes plain text files.]]>
  19917. </doc>
  19918. </class>
  19919. <!-- end class org.apache.hadoop.mapreduce.lib.output.TextOutputFormat -->
  19920. <!-- start class org.apache.hadoop.mapreduce.lib.output.TextOutputFormat.LineRecordWriter -->
  19921. <class name="TextOutputFormat.LineRecordWriter" extends="org.apache.hadoop.mapreduce.RecordWriter"
  19922. abstract="false"
  19923. static="true" final="false" visibility="protected"
  19924. deprecated="not deprecated">
  19925. <constructor name="TextOutputFormat.LineRecordWriter" type="java.io.DataOutputStream, java.lang.String"
  19926. static="false" final="false" visibility="public"
  19927. deprecated="not deprecated">
  19928. </constructor>
  19929. <constructor name="TextOutputFormat.LineRecordWriter" type="java.io.DataOutputStream"
  19930. static="false" final="false" visibility="public"
  19931. deprecated="not deprecated">
  19932. </constructor>
  19933. <method name="write"
  19934. abstract="false" native="false" synchronized="true"
  19935. static="false" final="false" visibility="public"
  19936. deprecated="not deprecated">
  19937. <param name="key" type="java.lang.Object"/>
  19938. <param name="value" type="java.lang.Object"/>
  19939. <exception name="IOException" type="java.io.IOException"/>
  19940. </method>
  19941. <method name="close"
  19942. abstract="false" native="false" synchronized="true"
  19943. static="false" final="false" visibility="public"
  19944. deprecated="not deprecated">
  19945. <param name="context" type="org.apache.hadoop.mapreduce.TaskAttemptContext"/>
  19946. <exception name="IOException" type="java.io.IOException"/>
  19947. </method>
  19948. <field name="out" type="java.io.DataOutputStream"
  19949. transient="false" volatile="false"
  19950. static="false" final="false" visibility="protected"
  19951. deprecated="not deprecated">
  19952. </field>
  19953. </class>
  19954. <!-- end class org.apache.hadoop.mapreduce.lib.output.TextOutputFormat.LineRecordWriter -->
  19955. </package>
  19956. <package name="org.apache.hadoop.mapreduce.lib.partition">
  19957. <!-- start class org.apache.hadoop.mapreduce.lib.partition.HashPartitioner -->
  19958. <class name="HashPartitioner" extends="org.apache.hadoop.mapreduce.Partitioner"
  19959. abstract="false"
  19960. static="false" final="false" visibility="public"
  19961. deprecated="not deprecated">
  19962. <constructor name="HashPartitioner"
  19963. static="false" final="false" visibility="public"
  19964. deprecated="not deprecated">
  19965. </constructor>
  19966. <method name="getPartition" return="int"
  19967. abstract="false" native="false" synchronized="false"
  19968. static="false" final="false" visibility="public"
  19969. deprecated="not deprecated">
  19970. <param name="key" type="java.lang.Object"/>
  19971. <param name="value" type="java.lang.Object"/>
  19972. <param name="numReduceTasks" type="int"/>
  19973. <doc>
  19974. <![CDATA[Use {@link Object#hashCode()} to partition.]]>
  19975. </doc>
  19976. </method>
  19977. <doc>
  19978. <![CDATA[Partition keys by their {@link Object#hashCode()}.]]>
  19979. </doc>
  19980. </class>
  19981. <!-- end class org.apache.hadoop.mapreduce.lib.partition.HashPartitioner -->
  19982. </package>
  19983. <package name="org.apache.hadoop.mapreduce.lib.reduce">
  19984. <!-- start class org.apache.hadoop.mapreduce.lib.reduce.IntSumReducer -->
  19985. <class name="IntSumReducer" extends="org.apache.hadoop.mapreduce.Reducer"
  19986. abstract="false"
  19987. static="false" final="false" visibility="public"
  19988. deprecated="not deprecated">
  19989. <constructor name="IntSumReducer"
  19990. static="false" final="false" visibility="public"
  19991. deprecated="not deprecated">
  19992. </constructor>
  19993. <method name="reduce"
  19994. abstract="false" native="false" synchronized="false"
  19995. static="false" final="false" visibility="public"
  19996. deprecated="not deprecated">
  19997. <param name="key" type="java.lang.Object"/>
  19998. <param name="values" type="java.lang.Iterable"/>
  19999. <param name="context" type="org.apache.hadoop.mapreduce.Reducer.Context"/>
  20000. <exception name="IOException" type="java.io.IOException"/>
  20001. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  20002. </method>
  20003. </class>
  20004. <!-- end class org.apache.hadoop.mapreduce.lib.reduce.IntSumReducer -->
  20005. <!-- start class org.apache.hadoop.mapreduce.lib.reduce.LongSumReducer -->
  20006. <class name="LongSumReducer" extends="org.apache.hadoop.mapreduce.Reducer"
  20007. abstract="false"
  20008. static="false" final="false" visibility="public"
  20009. deprecated="not deprecated">
  20010. <constructor name="LongSumReducer"
  20011. static="false" final="false" visibility="public"
  20012. deprecated="not deprecated">
  20013. </constructor>
  20014. <method name="reduce"
  20015. abstract="false" native="false" synchronized="false"
  20016. static="false" final="false" visibility="public"
  20017. deprecated="not deprecated">
  20018. <param name="key" type="java.lang.Object"/>
  20019. <param name="values" type="java.lang.Iterable"/>
  20020. <param name="context" type="org.apache.hadoop.mapreduce.Reducer.Context"/>
  20021. <exception name="IOException" type="java.io.IOException"/>
  20022. <exception name="InterruptedException" type="java.lang.InterruptedException"/>
  20023. </method>
  20024. </class>
  20025. <!-- end class org.apache.hadoop.mapreduce.lib.reduce.LongSumReducer -->
  20026. </package>
  20027. <package name="org.apache.hadoop.tools">
  20028. <!-- start class org.apache.hadoop.tools.DistCh -->
  20029. <class name="DistCh" extends="org.apache.hadoop.tools.DistTool"
  20030. abstract="false"
  20031. static="false" final="false" visibility="public"
  20032. deprecated="not deprecated">
  20033. <method name="run" return="int"
  20034. abstract="false" native="false" synchronized="false"
  20035. static="false" final="false" visibility="public"
  20036. deprecated="not deprecated">
  20037. <param name="args" type="java.lang.String[]"/>
  20038. <exception name="Exception" type="java.lang.Exception"/>
  20039. <doc>
  20040. <![CDATA[This is the main driver for recursively changing files properties.]]>
  20041. </doc>
  20042. </method>
  20043. <method name="main"
  20044. abstract="false" native="false" synchronized="false"
  20045. static="true" final="false" visibility="public"
  20046. deprecated="not deprecated">
  20047. <param name="args" type="java.lang.String[]"/>
  20048. <exception name="Exception" type="java.lang.Exception"/>
  20049. </method>
  20050. <doc>
  20051. <![CDATA[A Map-reduce program to recursively change files properties
  20052. such as owner, group and permission.]]>
  20053. </doc>
  20054. </class>
  20055. <!-- end class org.apache.hadoop.tools.DistCh -->
  20056. <!-- start class org.apache.hadoop.tools.DistCp -->
  20057. <class name="DistCp" extends="java.lang.Object"
  20058. abstract="false"
  20059. static="false" final="false" visibility="public"
  20060. deprecated="not deprecated">
  20061. <implements name="org.apache.hadoop.util.Tool"/>
  20062. <constructor name="DistCp" type="org.apache.hadoop.conf.Configuration"
  20063. static="false" final="false" visibility="public"
  20064. deprecated="not deprecated">
  20065. </constructor>
  20066. <method name="setConf"
  20067. abstract="false" native="false" synchronized="false"
  20068. static="false" final="false" visibility="public"
  20069. deprecated="not deprecated">
  20070. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  20071. </method>
  20072. <method name="getConf" return="org.apache.hadoop.conf.Configuration"
  20073. abstract="false" native="false" synchronized="false"
  20074. static="false" final="false" visibility="public"
  20075. deprecated="not deprecated">
  20076. </method>
  20077. <method name="copy"
  20078. abstract="false" native="false" synchronized="false"
  20079. static="true" final="false" visibility="public"
  20080. deprecated="not deprecated">
  20081. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  20082. <param name="srcPath" type="java.lang.String"/>
  20083. <param name="destPath" type="java.lang.String"/>
  20084. <param name="logPath" type="org.apache.hadoop.fs.Path"/>
  20085. <param name="srcAsList" type="boolean"/>
  20086. <param name="ignoreReadFailures" type="boolean"/>
  20087. <exception name="IOException" type="java.io.IOException"/>
  20088. </method>
  20089. <method name="run" return="int"
  20090. abstract="false" native="false" synchronized="false"
  20091. static="false" final="false" visibility="public"
  20092. deprecated="not deprecated">
  20093. <param name="args" type="java.lang.String[]"/>
  20094. <doc>
  20095. <![CDATA[This is the main driver for recursively copying directories
  20096. across file systems. It takes at least two cmdline parameters. A source
  20097. URL and a destination URL. It then essentially does an "ls -lR" on the
  20098. source URL, and writes the output in a round-robin manner to all the map
  20099. input files. The mapper actually copies the files allotted to it. The
  20100. reduce is empty.]]>
  20101. </doc>
  20102. </method>
  20103. <method name="main"
  20104. abstract="false" native="false" synchronized="false"
  20105. static="true" final="false" visibility="public"
  20106. deprecated="not deprecated">
  20107. <param name="args" type="java.lang.String[]"/>
  20108. <exception name="Exception" type="java.lang.Exception"/>
  20109. </method>
  20110. <method name="getRandomId" return="java.lang.String"
  20111. abstract="false" native="false" synchronized="false"
  20112. static="true" final="false" visibility="public"
  20113. deprecated="not deprecated">
  20114. </method>
  20115. <field name="LOG" type="org.apache.commons.logging.Log"
  20116. transient="false" volatile="false"
  20117. static="true" final="true" visibility="public"
  20118. deprecated="not deprecated">
  20119. </field>
  20120. <doc>
  20121. <![CDATA[A Map-reduce program to recursively copy directories between
  20122. different file-systems.]]>
  20123. </doc>
  20124. </class>
  20125. <!-- end class org.apache.hadoop.tools.DistCp -->
  20126. <!-- start class org.apache.hadoop.tools.DistCp.DuplicationException -->
  20127. <class name="DistCp.DuplicationException" extends="java.io.IOException"
  20128. abstract="false"
  20129. static="true" final="false" visibility="public"
  20130. deprecated="not deprecated">
  20131. <field name="ERROR_CODE" type="int"
  20132. transient="false" volatile="false"
  20133. static="true" final="true" visibility="public"
  20134. deprecated="not deprecated">
  20135. <doc>
  20136. <![CDATA[Error code for this exception]]>
  20137. </doc>
  20138. </field>
  20139. <doc>
  20140. <![CDATA[An exception class for duplicated source files.]]>
  20141. </doc>
  20142. </class>
  20143. <!-- end class org.apache.hadoop.tools.DistCp.DuplicationException -->
  20144. <!-- start class org.apache.hadoop.tools.HadoopArchives -->
  20145. <class name="HadoopArchives" extends="java.lang.Object"
  20146. abstract="false"
  20147. static="false" final="false" visibility="public"
  20148. deprecated="not deprecated">
  20149. <implements name="org.apache.hadoop.util.Tool"/>
  20150. <constructor name="HadoopArchives" type="org.apache.hadoop.conf.Configuration"
  20151. static="false" final="false" visibility="public"
  20152. deprecated="not deprecated">
  20153. </constructor>
  20154. <method name="setConf"
  20155. abstract="false" native="false" synchronized="false"
  20156. static="false" final="false" visibility="public"
  20157. deprecated="not deprecated">
  20158. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  20159. </method>
  20160. <method name="getConf" return="org.apache.hadoop.conf.Configuration"
  20161. abstract="false" native="false" synchronized="false"
  20162. static="false" final="false" visibility="public"
  20163. deprecated="not deprecated">
  20164. </method>
  20165. <method name="archive"
  20166. abstract="false" native="false" synchronized="false"
  20167. static="false" final="false" visibility="public"
  20168. deprecated="not deprecated">
  20169. <param name="srcPaths" type="java.util.List"/>
  20170. <param name="archiveName" type="java.lang.String"/>
  20171. <param name="dest" type="org.apache.hadoop.fs.Path"/>
  20172. <exception name="IOException" type="java.io.IOException"/>
  20173. <doc>
  20174. <![CDATA[archive the given source paths into
  20175. the dest
  20176. @param srcPaths the src paths to be archived
  20177. @param dest the dest dir that will contain the archive]]>
  20178. </doc>
  20179. </method>
  20180. <method name="run" return="int"
  20181. abstract="false" native="false" synchronized="false"
  20182. static="false" final="false" visibility="public"
  20183. deprecated="not deprecated">
  20184. <param name="args" type="java.lang.String[]"/>
  20185. <exception name="Exception" type="java.lang.Exception"/>
  20186. <doc>
  20187. <![CDATA[the main driver for creating the archives
  20188. it takes at least two command line parameters. The src and the
  20189. dest. It does an lsr on the source paths.
  20190. The mapper created archuves and the reducer creates
  20191. the archive index.]]>
  20192. </doc>
  20193. </method>
  20194. <method name="main"
  20195. abstract="false" native="false" synchronized="false"
  20196. static="true" final="false" visibility="public"
  20197. deprecated="not deprecated">
  20198. <param name="args" type="java.lang.String[]"/>
  20199. <doc>
  20200. <![CDATA[the main functions]]>
  20201. </doc>
  20202. </method>
  20203. <doc>
  20204. <![CDATA[a archive creation utility.
  20205. This class provides methods that can be used
  20206. to create hadoop archives. For understanding of
  20207. Hadoop archives look at {@link HarFileSystem}.]]>
  20208. </doc>
  20209. </class>
  20210. <!-- end class org.apache.hadoop.tools.HadoopArchives -->
  20211. <!-- start class org.apache.hadoop.tools.Logalyzer -->
  20212. <class name="Logalyzer" extends="java.lang.Object"
  20213. abstract="false"
  20214. static="false" final="false" visibility="public"
  20215. deprecated="not deprecated">
  20216. <constructor name="Logalyzer"
  20217. static="false" final="false" visibility="public"
  20218. deprecated="not deprecated">
  20219. </constructor>
  20220. <method name="doArchive"
  20221. abstract="false" native="false" synchronized="false"
  20222. static="false" final="false" visibility="public"
  20223. deprecated="not deprecated">
  20224. <param name="logListURI" type="java.lang.String"/>
  20225. <param name="archiveDirectory" type="java.lang.String"/>
  20226. <exception name="IOException" type="java.io.IOException"/>
  20227. <doc>
  20228. <![CDATA[doArchive: Workhorse function to archive log-files.
  20229. @param logListURI : The uri which will serve list of log-files to archive.
  20230. @param archiveDirectory : The directory to store archived logfiles.
  20231. @throws IOException]]>
  20232. </doc>
  20233. </method>
  20234. <method name="doAnalyze"
  20235. abstract="false" native="false" synchronized="false"
  20236. static="false" final="false" visibility="public"
  20237. deprecated="not deprecated">
  20238. <param name="inputFilesDirectory" type="java.lang.String"/>
  20239. <param name="outputDirectory" type="java.lang.String"/>
  20240. <param name="grepPattern" type="java.lang.String"/>
  20241. <param name="sortColumns" type="java.lang.String"/>
  20242. <param name="columnSeparator" type="java.lang.String"/>
  20243. <exception name="IOException" type="java.io.IOException"/>
  20244. <doc>
  20245. <![CDATA[doAnalyze:
  20246. @param inputFilesDirectory : Directory containing the files to be analyzed.
  20247. @param outputDirectory : Directory to store analysis (output).
  20248. @param grepPattern : Pattern to *grep* for.
  20249. @param sortColumns : Sort specification for output.
  20250. @param columnSeparator : Column separator.
  20251. @throws IOException]]>
  20252. </doc>
  20253. </method>
  20254. <method name="main"
  20255. abstract="false" native="false" synchronized="false"
  20256. static="true" final="false" visibility="public"
  20257. deprecated="not deprecated">
  20258. <param name="args" type="java.lang.String[]"/>
  20259. </method>
  20260. <doc>
  20261. <![CDATA[Logalyzer: A utility tool for archiving and analyzing hadoop logs.
  20262. <p>
  20263. This tool supports archiving and anaylzing (sort/grep) of log-files.
  20264. It takes as input
  20265. a) Input uri which will serve uris of the logs to be archived.
  20266. b) Output directory (not mandatory).
  20267. b) Directory on dfs to archive the logs.
  20268. c) The sort/grep patterns for analyzing the files and separator for boundaries.
  20269. Usage:
  20270. Logalyzer -archive -archiveDir <directory to archive logs> -analysis <directory> -logs <log-list uri> -grep <pattern> -sort <col1, col2> -separator <separator>
  20271. <p>]]>
  20272. </doc>
  20273. </class>
  20274. <!-- end class org.apache.hadoop.tools.Logalyzer -->
  20275. <!-- start class org.apache.hadoop.tools.Logalyzer.LogComparator -->
  20276. <class name="Logalyzer.LogComparator" extends="org.apache.hadoop.io.Text.Comparator"
  20277. abstract="false"
  20278. static="true" final="false" visibility="public"
  20279. deprecated="not deprecated">
  20280. <implements name="org.apache.hadoop.conf.Configurable"/>
  20281. <constructor name="Logalyzer.LogComparator"
  20282. static="false" final="false" visibility="public"
  20283. deprecated="not deprecated">
  20284. </constructor>
  20285. <method name="setConf"
  20286. abstract="false" native="false" synchronized="false"
  20287. static="false" final="false" visibility="public"
  20288. deprecated="not deprecated">
  20289. <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
  20290. </method>
  20291. <method name="getConf" return="org.apache.hadoop.conf.Configuration"
  20292. abstract="false" native="false" synchronized="false"
  20293. static="false" final="false" visibility="public"
  20294. deprecated="not deprecated">
  20295. </method>
  20296. <method name="compare" return="int"
  20297. abstract="false" native="false" synchronized="false"
  20298. static="false" final="false" visibility="public"
  20299. deprecated="not deprecated">
  20300. <param name="b1" type="byte[]"/>
  20301. <param name="s1" type="int"/>
  20302. <param name="l1" type="int"/>
  20303. <param name="b2" type="byte[]"/>
  20304. <param name="s2" type="int"/>
  20305. <param name="l2" type="int"/>
  20306. </method>
  20307. <doc>
  20308. <![CDATA[A WritableComparator optimized for UTF8 keys of the logs.]]>
  20309. </doc>
  20310. </class>
  20311. <!-- end class org.apache.hadoop.tools.Logalyzer.LogComparator -->
  20312. <!-- start class org.apache.hadoop.tools.Logalyzer.LogRegexMapper -->
  20313. <class name="Logalyzer.LogRegexMapper" extends="org.apache.hadoop.mapred.MapReduceBase"
  20314. abstract="false"
  20315. static="true" final="false" visibility="public"
  20316. deprecated="not deprecated">
  20317. <implements name="org.apache.hadoop.mapred.Mapper"/>
  20318. <constructor name="Logalyzer.LogRegexMapper"
  20319. static="false" final="false" visibility="public"
  20320. deprecated="not deprecated">
  20321. </constructor>
  20322. <method name="configure"
  20323. abstract="false" native="false" synchronized="false"
  20324. static="false" final="false" visibility="public"
  20325. deprecated="not deprecated">
  20326. <param name="job" type="org.apache.hadoop.mapred.JobConf"/>
  20327. </method>
  20328. <method name="map"
  20329. abstract="false" native="false" synchronized="false"
  20330. static="false" final="false" visibility="public"
  20331. deprecated="not deprecated">
  20332. <param name="key" type="org.apache.hadoop.io.WritableComparable"/>
  20333. <param name="value" type="org.apache.hadoop.io.Text"/>
  20334. <param name="output" type="org.apache.hadoop.mapred.OutputCollector"/>
  20335. <param name="reporter" type="org.apache.hadoop.mapred.Reporter"/>
  20336. <exception name="IOException" type="java.io.IOException"/>
  20337. </method>
  20338. <doc>
  20339. <![CDATA[A {@link Mapper} that extracts text matching a regular expression.]]>
  20340. </doc>
  20341. </class>
  20342. <!-- end class org.apache.hadoop.tools.Logalyzer.LogRegexMapper -->
  20343. </package>
  20344. </api>